[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.259 by sf-exg, Sun Dec 19 20:48:21 2021 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>
…		…
113	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
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
119	=item B<-tr>\|B<+tr>
120
121	Turn on/off illusion of a transparent window background; resource B<transparent>.
122
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		132
129	=item B<-fade> I<number>	133	=item B<-fade> I<number>
130		134
131	Fade the text by the given percentage when focus is lost. Small values	135	Fade the text by the given percentage when focus is lost. Small values
132	fade a little only, 100 completely replaces all colours by the fade	136	fade a little only, 100 completely replaces all colours by the fade
…		…
135	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
136		140
137	Fade to this colour when fading is used (see B<-fade>). The default colour	141	Fade to this colour when fading is used (see B<-fade>). The default colour
138	is opaque black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
139		143
140	=item B<-tint> I<colour>	144	=item B<-icon> I<file>
141		145
142	Tint the transparent background pixmap with the given colour when	146	Compile I<pixbuf>: Use the specified image as application icon. This
143	transparency is enabled with B<-tr>. This only works for	147	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	148	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		149
179	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
180		151
181	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
182		153
183	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
184		155
185	Window foreground colour; resource B<foreground>.	156	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		157
194	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
195		159
196	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
197		161
…		…
242	italic> >> characters are to be printed. See resource B<boldItalicFont>	206	italic> >> characters are to be printed. See resource B<boldItalicFont>
243	for details.	207	for details.
244		208
245	=item B<-is>\|B<+is>	209	=item B<-is>\|B<+is>
246		210
247	Compile I<font-styles>: Bold/Italic font styles imply high intensity	211	Compile I<font-styles>: Bold/Blink font styles imply high intensity
248	foreground/background (default). See resource B<intensityStyles> for	212	foreground/background (default). See resource B<intensityStyles> for
249	details.	213	details.
250		214
251	=item B<-name> I<name>	215	=item B<-name> I<name>
252		216
…		…
256		220
257	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
258		222
259	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
260		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
261	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
262		230
263	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
264	B<utmpInhibit>.	232	B<utmpInhibit>.
265		233
…		…
269	B<visualBell>.	237	B<visualBell>.
270		238
271	=item B<-sb>\|B<+sb>	239	=item B<-sb>\|B<+sb>
272		240
273	Turn on/off scrollbar; resource B<scrollBar>.	241	Turn on/off scrollbar; resource B<scrollBar>.
		242
		243	=item B<-sr>\|B<+sr>
		244
		245	Put scrollbar on right/left; resource B<scrollBar_right>.
		246
		247	=item B<-st>\|B<+st>
		248
		249	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		250	resource B<scrollBar_floating>.
274		251
275	=item B<-si>\|B<+si>	252	=item B<-si>\|B<+si>
276		253
277	Turn on/off scroll-to-bottom on TTY output inhibit; resource	254	Turn on/off scroll-to-bottom on TTY output inhibit; resource
278	B<scrollTtyOutput> has opposite effect.	255	B<scrollTtyOutput> has opposite effect.
…		…
285	=item B<-sw>\|B<+sw>	262	=item B<-sw>\|B<+sw>
286		263
287	Turn on/off scrolling with the scrollback buffer as new lines appear.	264	Turn on/off scrolling with the scrollback buffer as new lines appear.
288	This only takes effect if B<-si> is also given; resource	265	This only takes effect if B<-si> is also given; resource
289	B<scrollWithBuffer>.	266	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		267
300	=item B<-ptab>\|B<+ptab>	268	=item B<-ptab>\|B<+ptab>
301		269
302	If enabled (default), "Horizontal Tab" characters are being stored as	270	If enabled (default), "Horizontal Tab" characters are being stored as
303	actual wide characters in the screen buffer, which makes it possible to	271	actual wide characters in the screen buffer, which makes it possible to
…		…
307		275
308	=item B<-bc>\|B<+bc>	276	=item B<-bc>\|B<+bc>
309		277
310	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
311		279
		280	=item B<-uc>\|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
		283
312	=item B<-iconic>	284	=item B<-iconic>
313		285
314	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
315	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
316		288
…		…
332		304
333	=item B<-bl>	305	=item B<-bl>
334		306
335	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
336	if honoured by the WM, the rxvt-unicode window will not have window	308	if honoured by the WM, the rxvt-unicode window will not have window
337	decorations; resource B<borderLess>.	309	decorations; resource B<borderLess>. If the window manager does not
		310	support MWM hints (e.g. kwin), enables override-redirect mode.
338		311
339	=item B<-override-redirect>	312	=item B<-override-redirect>
340		313
341	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
342	B<override-redirect>.	315	B<override-redirect>.
		316
		317	=item B<-dockapp>
		318
		319	Sets the initial state of the window to WithdrawnState, which makes
		320	window managers that support this extension treat it as a dockapp.
343		321
344	=item B<-sbg>	322	=item B<-sbg>
345		323
346	Compile I<frills>: Disable the usage of the built-in block graphics/line	324	Compile I<frills>: Disable the usage of the built-in block graphics/line
347	drawing characters and just rely on what the specified fonts provide. Use	325	drawing characters and just rely on what the specified fonts provide. Use
…		…
351	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
352		330
353	Compile I<frills>: Lines (pixel height) to insert between each row of	331	Compile I<frills>: Lines (pixel height) to insert between each row of
354	the display. Useful to work around font rendering problems; resource	332	the display. Useful to work around font rendering problems; resource
355	B<lineSpace>.	333	B<lineSpace>.
		334
		335	=item B<-letsp> I<number>
		336
		337	Compile I<frills>: Amount to adjust the computed character width by
		338	to control overall letter spacing. Negative values will tighten up the
		339	letter spacing, positive values will space letters out more. Useful to
		340	work around odd font metrics; resource B<letterSpace>.
356		341
357	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
358		343
359	This option specifies the name of the terminal type to be set in the	344	This option specifies the name of the terminal type to be set in the
360	B<TERM> environment variable. This terminal type must exist in the	345	B<TERM> environment variable. This terminal type must exist in the
…		…
395	=item B<-pt> I<style>	380	=item B<-pt> I<style>
396		381
397	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
398	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
399		384
		385	If the perl extension C<xim-onthespot> is used (which is the default),
		386	then additionally the C<OnTheSpot> preedit type is available.
		387
400	=item B<-im> I<text>	388	=item B<-im> I<text>
401		389
402	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
403		391
404	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
415		403
416	=item B<-tcw>	404	=item B<-tcw>
417		405
418	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
419	button. Only effective when the original (non-perl) selection code is	407	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	408	in-use. Instead of selecting a full line it will extend the selection to
421	end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
		410
		411	=item B<-dpb>\|B<+dpb>
		412
		413	Compile frills: Disable (or enable) emitting bracketed paste mode
		414	sequences (default enabled). Bracketed paste mode allows programs
		415	to detect when something is pasted. Since more and more programs
		416	abuse this, these sequences can be disabled. The command sequences to
		417	enable and query paste mode will still work, but the actual bracket
		418	sequences will no longer be emitted. You can also toggle this from the
		419	ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
422		420
423	=item B<-insecure>	421	=item B<-insecure>
424		422
425	Enable "insecure" mode, which currently enables most of the escape	423	Enable "insecure" mode, which currently enables most of the escape
426	sequences that echo strings. See the resource B<insecure> for more	424	sequences that echo strings. See the resource B<insecure> for more
…		…
439		437
440	=item B<-ssr>\|B<+ssr>	438	=item B<-ssr>\|B<+ssr>
441		439
442	Turn on/off secondary screen scroll (default enabled); resource	440	Turn on/off secondary screen scroll (default enabled); resource
443	B<secondaryScroll>.	441	B<secondaryScroll>.
		442
		443	=item B<-rm> I<mode>
		444
		445	Compile I<frills>: Sets long line rewrapping behaviour on window resizes
		446	to one of B<auto> (the default), B<always> or B<never>. The latter two
		447	modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
		448	is non-empty, and wings lines (acts like B<never>) otherwise; resource
		449	B<rewrapMode>.
444		450
445	=item B<-hold>\|B<+hold>	451	=item B<-hold>\|B<+hold>
446		452
447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	453	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448	will not immediately destroy its window when the program executed within	454	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	455	it exits. Instead, it will wait till it is being killed or closed by the
450	user; resource B<hold>.	456	user; resource B<hold>.
		457
		458	=item B<-cd> I<path>
		459
		460	Sets the working directory for the shell (or the command specified via
		461	B<-e>). The I<path> must be an absolute path and it must exist for
		462	@@RXVT_NAME@@ to start; resource B<chdir>.
451		463
452	=item B<-xrm> I<string>	464	=item B<-xrm> I<string>
453		465
454	Works like the X Toolkit option of the same name, by adding the I<string>	466	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	467	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	515	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	516	entries and will not tinker with pty/tty permissions - you have to do that
505	yourself if you want that.	517	yourself if you want that.
506		518
507	As an extremely special case, specifying C<-1> will completely suppress	519	As an extremely special case, specifying C<-1> will completely suppress
508	pty/tty operations.	520	pty/tty operations, which is probably only useful in conjunction with some
		521	perl extension that manages the terminal.
509		522
510	Here is a example in perl that illustrates how this option can be used (a	523	Here is a example in perl that illustrates how this option can be used (a
511	longer example is in F<doc/pty-fd>):	524	longer example is in F<doc/pty-fd>):
512		525
513	use IO::Pty;	526	use IO::Pty;
…		…
520		533
521	# now communicate with rxvt	534	# now communicate with rxvt
522	my $slave = $pty->slave;	535	my $slave = $pty->slave;
523	while (<$slave>) { print $slave "got <$_>\n" }	536	while (<$slave>) { print $slave "got <$_>\n" }
524		537
		538	Note that, despite what the name might imply, the file descriptor does not
		539	need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
		540	domain or tcp socket). While tty operations cannot be done in this case,
		541	B<@@RXVT_NAME@@> can still be remote controlled with it:
		542
		543	use Socket;
		544	use Fcntl;
		545
		546	socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
		547	fcntl $slave, Fcntl::F_SETFD, 0;
		548	system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
		549	close $slave;
		550
		551	syswrite $URXVT, "Type a secret password: ";
		552	my $secret = do { local $/ = "\r"; <$URXVT> };
		553	print "Not so secret anymore: $secret\n";
		554
525	=item B<-pe> I<string>	555	=item B<-pe> I<string>
526		556
527	Comma-separated list of perl extension scripts to use (or not to use) in	557	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.	558	this terminal instance. See resource B<perl-ext> for details.
529		559
530	=back	560	=back
531		561
532	=head1 RESOURCES (available also as long-options)	562	=head1 RESOURCES
533		563
534	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	564	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
535	options) compiled into your version.	565	options) compiled into your version. All resources are also available as
		566	long-options.
536		567
537	You can set and change the resources using X11 tools like B<xrdb>. Many	568	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	569	distribution do also load settings from the B<~/.Xresources> file when X
539	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	570	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
540	with later settings overwriting earlier ones:	571	with later settings overwriting earlier ones:
541		572
542	1. system-wide app-defaults file, either locale-dependent OR global
543	2. app-defaults file in $XAPPLRESDIR	573	1. app-defaults file in $XAPPLRESDIR
		574	2. $HOME/.Xdefaults
544	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	575	3. RESOURCE_MANAGER property on root-window of screen 0
545	4. SCREEN_RESOURCES for the current screen	576	4. SCREEN_RESOURCES property on root-window of the current screen
546	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	577	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
547	6. resources specified via -xrm on the commandline	578	6. resources specified via -xrm on the commandline
548		579
549	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	580	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	581	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	586	be used. Command-line arguments can be used to override resource
556	settings. The following resources are supported (you might want to	587	settings. The following resources are supported (you might want to
557	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	588	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
558	extensions not documented here):	589	extensions not documented here):
559		590
560	=over 4	591	=over
561		592
562	=item B<depth:> I<bitdepth>	593	=item B<depth:> I<bitdepth>
563		594
564	Compile I<xft>: Attempt to find a visual with the given bit depth;	595	Compile I<xft>: Attempt to find a visual with the given bit depth;
565	option B<-depth>.	596	option B<-depth>.
		597
		598	=item B<buffered:> I<boolean>
		599
		600	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		601	On some card/driver combination enabling it slightly decreases
		602	performance, on most it greatly helps it. The slowdown is small, so it
		603	should normally be enabled.
566		604
567	=item B<geometry:> I<geom>	605	=item B<geometry:> I<geom>
568		606
569	Create the window with the specified X window geometry [default 80x24];	607	Create the window with the specified X window geometry [default 80x24];
570	option B<-geometry>.	608	option B<-geometry>.
…		…
584	Use the specified colour for the colour value I<n>, where 0-7	622	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	623	corresponds to low-intensity (normal) colours and 8-15 corresponds to
586	high-intensity (bold = bright foreground, blink = bright background)	624	high-intensity (bold = bright foreground, blink = bright background)
587	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	625	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	626	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.	627	names used are listed in the B<COLOURS AND GRAPHICS> section.
590		628
591	Colours higher than 15 cannot be set using resources (yet), but can be	629	Colours higher than 15 cannot be set using resources (yet), but can be
592	changed using an escape command (see @@RXVT_NAME@@(7)).	630	changed using an escape command (see @@RXVT_NAME@@(7)).
593		631
594	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	632	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
605	=item B<colorUL:> I<colour>	643	=item B<colorUL:> I<colour>
606		644
607	Use the specified colour to display underlined characters when the	645	Use the specified colour to display underlined characters when the
608	foreground colour is the default.	646	foreground colour is the default.
609		647
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>	648	=item B<underlineColor:> I<colour>
616		649
617	If set, use the specified colour as the colour for the underline	650	If set, use the specified colour as the colour for the underline
618	itself. If unset, use the foreground colour.	651	itself. If unset, use the foreground colour.
		652
		653	=item B<highlightColor:> I<colour>
		654
		655	If set, use the specified colour as the background for highlighted
		656	characters. If unset, use reverse video.
		657
		658	=item B<highlightTextColor:> I<colour>
		659
		660	If set and highlightColor is set, use the specified colour as the
		661	foreground for highlighted characters.
619		662
620	=item B<cursorColor:> I<colour>	663	=item B<cursorColor:> I<colour>
621		664
622	Use the specified colour for the cursor. The default is to use the	665	Use the specified colour for the cursor. The default is to use the
623	foreground colour; option B<-cr>.	666	foreground colour; option B<-cr>.
…		…
630		673
631	=item B<reverseVideo:> I<boolean>	674	=item B<reverseVideo:> I<boolean>
632		675
633	B<True>: simulate reverse video by foreground and background colours;	676	B<True>: simulate reverse video by foreground and background colours;
634	option B<-rv>. B<False>: regular screen colours [default]; option	677	option B<-rv>. B<False>: regular screen colours [default]; option
635	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	678	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
636		679
637	=item B<jumpScroll:> I<boolean>	680	=item B<jumpScroll:> I<boolean>
638		681
639	B<True>: specify that jump scrolling should be used. When receiving lots	682	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	683	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
654		697
655	B<False>: specify that everything is to be displayed, even	698	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	699	if the refresh is too fast for the human eye to read anything (or the
657	monitor to display anything); option B<+ss>.	700	monitor to display anything); option B<+ss>.
658		701
659	=item B<transparent:> I<boolean>
660
661	Turn on/off illusion of a transparent window background.
662
663	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
664	future versions.
665
666	I<Please address all transparency related issues to Sasha Vasko at
667	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
668
669	=item B<fading:> I<number>	702	=item B<fading:> I<number>
670		703
671	Fade the text by the given percentage when focus is lost; option B<-fade>.	704	Fade the text by the given percentage when focus is lost; option B<-fade>.
672		705
673	=item B<fadeColor:> I<colour>	706	=item B<fadeColor:> I<colour>
674		707
675	Fade to this colour, when fading is used (see B<fading:>). The default	708	Fade to this colour, when fading is used (see B<fading:>). The default
676	colour is black; option B<-fadecolor>.	709	colour is black; option B<-fadecolor>.
677		710
678	=item B<tintColor:> I<colour>	711	=item B<iconFile:> I<file>
679		712
680	Tint the transparent background pixmap with the given colour; option	713	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		714
697	=item B<scrollColor:> I<colour>	715	=item B<scrollColor:> I<colour>
698		716
699	Use the specified colour for the scrollbar [default #B2B2B2].	717	Use the specified colour for the scrollbar [default #B2B2B2].
700		718
…		…
705		723
706	=item B<borderColor:> I<colour>	724	=item B<borderColor:> I<colour>
707		725
708	The colour of the border around the text area and between the scrollbar	726	The colour of the border around the text area and between the scrollbar
709	and the text.	727	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		728
741	=item B<font:> I<fontlist>	729	=item B<font:> I<fontlist>
742		730
743	Select the fonts to be used. This is a comma separated list of font names	731	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	732	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	755	it is named first) and thus defines the character cell grid to be 9 pixels
768	wide and 15 pixels high.	756	wide and 15 pixels high.
769		757
770	The second font is just used to add additional unicode characters not in	758	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	759	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	760	the bold version of the font does contain fewer characters, so this is a
773	useful supplement.	761	useful supplement.
774		762
775	The third font is an Xft font with aliasing turned off, and the characters	763	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	764	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.	765	contains other characters, but we are not interested in them.
…		…
801	text font will being used for the given style.	789	text font will being used for the given style.
802		790
803	=item B<intensityStyles:> I<boolean>	791	=item B<intensityStyles:> I<boolean>
804		792
805	When font styles are not enabled, or this option is enabled (B<True>,	793	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	794	option B<-is>, the default), bold/blink font styles imply high
807	intensity foreground/background colours. Disabling this option (B<False>,	795	intensity foreground/background colours. Disabling this option (B<False>,
808	option B<+is>) disables this behaviour, the high intensity colours are not	796	option B<+is>) disables this behaviour, the high intensity colours are not
809	reachable.	797	reachable.
810		798
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>	799	=item B<title:> I<string>
824		800
825	Set window title string, the default title is the command-line	801	Set window title string, the default title is the command-line
826	specified after the B<-e> option, if any, otherwise the application	802	specified after the B<-e> option, if any, otherwise the application
827	name; option B<-title>.	803	name; option B<-title>.
…		…
840	=item B<urgentOnBell:> I<boolean>	816	=item B<urgentOnBell:> I<boolean>
841		817
842	B<True>: set the urgency hint for the wm on receipt of a bell character.	818	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].	819	B<False>: do not set the urgency hint [default].
844		820
		821	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		822
845	=item B<visualBell:> I<boolean>	823	=item B<visualBell:> I<boolean>
846		824
847	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	825	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
848	B<False>: no visual bell [default]; option B<+vb>.	826	B<False>: no visual bell [default]; option B<+vb>.
849		827
…		…
851		829
852	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	830	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	831	the shell; option B<-ls>. B<False>: start as a normal sub-shell
854	[default]; option B<+ls>.	832	[default]; option B<+ls>.
855		833
		834	=item B<multiClickTime:> I<number>
		835
		836	Specify the maximum time in milliseconds between multi-click select
		837	events. The default is 500 milliseconds; option B<-mc>.
		838
856	=item B<utmpInhibit:> I<boolean>	839	=item B<utmpInhibit:> I<boolean>
857		840
858	B<True>: inhibit writing record into the system log file B<utmp>;	841	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>	842	option B<-ut>. B<False>: write record into the system log file B<utmp>
860	[default]; option B<+ut>.	843	[default]; option B<+ut>.
…		…
872	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	855	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
873		856
874	This creates a new file in your home directory with the screen contents	857	This creates a new file in your home directory with the screen contents
875	every time you hit C<Print>.	858	every time you hit C<Print>.
876		859
		860	=item B<scrollstyle:> I<mode>
		861
		862	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		863	the author's favourite.
		864
		865	=item B<thickness:> I<number>
		866
		867	Set the scrollbar width in pixels.
		868
877	=item B<scrollBar:> I<boolean>	869	=item B<scrollBar:> I<boolean>
878		870
879	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	871	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
880	disable the scrollbar; option B<+sb>.	872	disable the scrollbar; option B<+sb>.
881		873
…		…
900	B<False>: do not scroll to bottom when tty receives output; option	892	B<False>: do not scroll to bottom when tty receives output; option
901	B<+si>.	893	B<+si>.
902		894
903	=item B<scrollWithBuffer:> I<boolean>	895	=item B<scrollWithBuffer:> I<boolean>
904		896
905	B<True>: scroll with scrollback buffer when tty receives new lines (and	897	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	898	try to show the same lines) and B<scrollTtyOutput> is False; option
907	with scrollback buffer when tty receives new lines; option B<+sw>.	899	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		900	new lines; option B<+sw>.
908		901
909	=item B<scrollTtyKeypress:> I<boolean>	902	=item B<scrollTtyKeypress:> I<boolean>
910		903
911	B<True>: scroll to bottom when a non-special key is pressed. Special keys	904	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	905	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	906	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>.	907	bottom when a non-special key is pressed; option B<+sk>.
915		908
916	=item B<saveLines:> I<number>	909	=item B<saveLines:> I<number>
917		910
918	Save I<number> lines in the scrollback buffer [default 64]. This	911	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		912
921	=item B<internalBorder:> I<number>	913	=item B<internalBorder:> I<number>
922		914
923	Internal border of I<number> pixels. This resource is limited to 100;	915	Internal border of I<number> pixels. This resource is limited to 100;
924	option B<-b>.	916	option B<-b>.
…		…
968	=item B<cursorBlink:> I<boolean>	960	=item B<cursorBlink:> I<boolean>
969		961
970	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	962	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
971	option B<-bc>.	963	option B<-bc>.
972		964
		965	=item B<cursorUnderline:> I<boolean>
		966
		967	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		968	option B<-uc>.
		969
973	=item B<pointerBlank:> I<boolean>	970	=item B<pointerBlank:> I<boolean>
974		971
975	B<True>: blank the pointer when a key is pressed or after a set number	972	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	973	of seconds of inactivity. B<False>: the pointer is always visible
977	[default].	974	[default].
…		…
982		979
983	=item B<pointerColor2:> I<colour>	980	=item B<pointerColor2:> I<colour>
984		981
985	Mouse pointer background colour.	982	Mouse pointer background colour.
986		983
		984	=item B<pointerShape:> I<string>
		985
		986	Compile I<frills>: Specifies the name of the mouse pointer shape
		987	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		988	file for possible values (omit the C<XC_> prefix).
		989
987	=item B<pointerBlankDelay:> I<number>	990	=item B<pointerBlankDelay:> I<number>
988		991
989	Specifies number of seconds before blanking the pointer [default 2]. Use a	992	Specifies number of seconds before blanking the pointer [default 2]. Use a
990	large number (e.g. C<987654321>) to effectively disable the timeout.	993	large number (e.g. C<987654321>) to effectively disable the timeout.
991		994
992	=item B<backspacekey:> I<string>	995	=item B<backspacekey:> I<string>
993		996
994	The string to send when the backspace key is pressed. If set to B<DEC>	997	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>	998	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	999	(code 8) - which can be reversed with the appropriate DEC private mode
997	escape sequence.	1000	escape sequence.
998		1001
999	=item B<deletekey:> I<string>	1002	=item B<deletekey:> I<string>
1000		1003
…		…
1017		1020
1018	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1021	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1019		1022
1020	=item B<preeditType:> I<style>	1023	=item B<preeditType:> I<style>
1021		1024
1022	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1025	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1023		1026
1024	=item B<inputMethod:> I<name>	1027	=item B<inputMethod:> I<name>
1025		1028
1026	I<name> of inputMethod to use; option B<-im>.	1029	I<name> of inputMethod to use; option B<-im>.
1027		1030
…		…
1045		1048
1046	Change the meaning of triple-click selection with the left mouse	1049	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	1050	button. Instead of selecting a full line it will extend the selection to
1048	the end of the logical line only; option B<-tcw>.	1051	the end of the logical line only; option B<-tcw>.
1049		1052
		1053	=item B<disablePasteBrackets:> I<boolean>
		1054
		1055	Prevent emission of paste bracket sequences; option B<-dpb>.
		1056
1050	=item B<insecure:> I<boolean>	1057	=item B<insecure:> I<boolean>
1051		1058
1052	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1059	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1053	echo arbitrary strings like the icon name or the locale. This could be	1060	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	1061	abused if somebody gets 8-bit-clean access to your display, whether
1055	through a mail client displaying mail bodies unfiltered or through	1062	through a mail client displaying mail bodies unfiltered or through
1056	write(1) or any other means. Therefore, these sequences are disabled by	1063	write(1) or any other means. Therefore, these sequences are disabled by
1057	default. (Note that many other terminals, including xterm, have these	1064	default. (Note that many other terminals, including xterm, have these
…		…
1075		1082
1076	=item B<secondaryScreen:> I<boolean>	1083	=item B<secondaryScreen:> I<boolean>
1077		1084
1078	Turn on/off secondary screen (default enabled).	1085	Turn on/off secondary screen (default enabled).
1079		1086
		1087	=item B<rewrapMode:> I<mode>
		1088
		1089	Sets long line rewrap behaviour on window resize to one of B<auto>
		1090	(default), B<always> or B<never>.
		1091
1080	=item B<secondaryScroll:> I<boolean>	1092	=item B<secondaryScroll:> I<boolean>
1081		1093
1082	Turn on/off secondary screen scroll (default enabled). If this	1094	Turn on/off secondary screen scroll (default enabled). If this
1083	option is enabled, scrolls on the secondary screen will change the	1095	option is enabled, scrolls on the secondary screen will change the
1084	scrollback buffer and switching to/from the secondary screen will	1096	scrollback buffer and, when secondaryScreen is off, switching
1085	instead scroll the screen up.	1097	to/from the secondary screen will instead scroll the screen up.
1086		1098
1087	=item B<hold>: I<boolean>	1099	=item B<hold>: I<boolean>
1088		1100
1089	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1101	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1090	will not immediately destroy its window when the program executed within	1102	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	1103	it exits. Instead, it will wait till it is being killed or closed by the
1092	user.	1104	user.
1093		1105
		1106	=item B<chdir>: I<path>
		1107
		1108	Sets the working directory for the shell (or the command specified via
		1109	B<-e>). The I<path> must be an absolute path and it must exist for
		1110	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1111	directory will be used; option B<-cd>.
		1112
1094	=item B<keysym.>I<sym>: I<string>	1113	=item B<keysym.>I<sym>: I<action>
1095		1114
1096	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1115	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1097	intervening resource name B<keysym.> cannot be omitted.	1116	resource name B<keysym.> cannot be omitted.
1098		1117
1099	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1118	Using this resource, you can map key combinations such as
1100	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1119	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>,	1120	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>,	1121	terminal scroll up or down the way you want it, or any other thing an
1103	B<2>, B<3>, B<4>, B<5>.	1122	extension might provide.
		1123
		1124	The key combination that triggers the action, I<sym>, has the following format:
		1125
		1126	(modifiers-)key
		1127
		1128	Where I<modifiers> can be any combination of the following full or
		1129	abbreviated modifier names:
		1130
		1131	=begin table
		1132
		1133	B<ISOLevel3> B<I>
		1134	B<AppKeypad> B<K>
		1135	B<Control> B<C>
		1136	B<NumLock> B<N>
		1137	B<Shift> B<S>
		1138	B<Meta> B<M> I<or> B<A>
		1139	B<Lock> B<L>
		1140	B<Mod1> B<1>
		1141	B<Mod2> B<2>
		1142	B<Mod3> B<3>
		1143	B<Mod4> B<4>
		1144	B<Mod5> B<5>
		1145
		1146	=end table
1104		1147
1105	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1148	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	1149	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	1150	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1108	current application keymap mode state.	1151	current application keymap mode state.
1109		1152
1110	The spellings of I<key> can be obtained by using B<xev>(1) command or	1153	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	1154	match if I<at least> the specified identifiers are being set, and no other
		1155	key mappings with those and more bits are being defined. That means that
		1156	defining a mapping for C<a> will automatically provide definitions for
		1157	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1158	themselves. See the C<builtin:> action, below, for a way to work around
		1159	this when this is a problem.
		1160
		1161	The spelling of I<key> depends on your implementation of X. An easy way to
		1162	find a key name is to use the B<xev>(1) command. You can find a list by
		1163	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	1164	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	1165	value (B<0x0000 - 0xFFFF>).
1114	performed in an exact manner; however, the closest match is assured.
1115		1166
1116	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1167	As with any resource value, the I<action> string may contain backslash
		1168	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1117	number), see RESOURCES in C<man 7 X> for futher details.	1169	number), see RESOURCES in C<man 7 X> for further details.
1118		1170
1119	You can define a range of keysyms in one shot by providing a I<string>	1171	An action starts with an action prefix that selects a certain type
1120	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1172	of action, followed by a colon. An action string without colons is
		1173	interpreted as a literal string to pass to the tty (as if it was
		1174	prefixed with C<string:>).
		1175
		1176	The following action prefixes are known - extensions can provide
		1177	additional prefixes:
		1178
		1179	=over
		1180
		1181	=item string:STRING
		1182
		1183	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1184	then the remaining C<STRING> will be passed to the program running in the
		1185	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1186	string C<echo rm -rf /> followed by a newline:
		1187
		1188	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1189
		1190	This could in theory be used to completely redefine your keymap.
		1191
		1192	In addition, for actions of this type, you can define a range of
		1193	keysyms in one shot by loading the C<keysym-list> perl extension and
		1194	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1121	should be a character not used by the strings.	1195	the delimiter `/' should be a character not used by the strings.
1122		1196
1123	Its usage can be demonstrated by an example:	1197	Its usage can be demonstrated by an example:
1124		1198
1125	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1199	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1126		1200
1127	The above line is equivalent to the following three lines:	1201	The above line is equivalent to the following three lines:
1128		1202
1129	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1203	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1130	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1204	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1131	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1205	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1132		1206
		1207	=item command:STRING
		1208
1133	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1209	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	1210	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1211	the opposite of C<string:> - instead of sending it to the program running
		1212	in the terminal, it will be treated as if it were program output). This is
		1213	most useful to feed command sequences into @@RXVT_NAME@@.
		1214
1135	example the following means "change the current locale to C<zh_CN.GBK>	1215	For example the following means "change the current locale to C<zh_CN.GBK>
1136	when Control-Meta-c is being pressed":	1216	when Control-Meta-c is being pressed":
1137		1217
1138	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1218	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1139		1219
1140	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1220	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)	1221	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1142	manpage. For example, the F<selection> extension (activated via	1222	font-switching at runtime:
1143	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1144		1223
1145	URxvt.keysym.M-C-c: perl:selection:rot13	1224	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1225	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1146		1226
1147	Due the the large number of modifier combinations, a defined key mapping	1227	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	1228	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		1229
1154	Unfortunately, this will override built-in key mappings. For example	1230	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1231	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1232
		1233	=item builtin:
		1234
		1235	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1236	key binding existed for the key combination. The obvious use is to undo
		1237	the effect of existing bindings. The not so obvious use is to reinstate
		1238	bindings when another binding overrides too many modifiers.
		1239
1155	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1240	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	1241	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1157	user-defined keymap using the C<builtin:> replacement:	1242	"holes" into the user-defined keymap using the C<builtin:> replacement:
1158		1243
1159	URxvt.keysym.Insert: <my insert key sequence>	1244	URxvt.keysym.Insert: <my insert key sequence>
1160	URxvt.keysym.S-Insert: builtin:	1245	URxvt.keysym.S-Insert: builtin:
1161		1246
1162	The first line defines a mapping for C<Insert> and I<any> combination	1247	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	1248	of modifiers. The second line re-establishes the default mapping for
1164	C<Shift-Insert>.	1249	C<Shift-Insert>.
1165		1250
1166	The following example will map Control-Meta-1 and Control-Meta-2 to	1251	=item builtin-string:
1167	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1168	font-switching at runtime:
1169		1252
1170	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1253	This action is mainly useful to restore string mappings for keys that
1171	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1254	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1255	difficult to explain - basically, this action will send the string to the
		1256	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1257	action for it.
1172		1258
1173	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1259	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1174	info):	1260	selection when you press C<Shift-Insert>. With the following bindings, it
		1261	would instead emit the (undocumented, but what applications running in the
		1262	terminal might expect) sequence C<ESC [ 2 $> instead:
1175		1263
1176	URxvt.keysym.M-C-3: command:\033[8;25;80t	1264	URxvt.keysym.S-Insert: builtin-string:
1177	URxvt.keysym.M-C-4: command:\033[8;48;110t	1265	URxvt.keysym.C-S-Insert: builtin:
		1266
		1267	The first line disables the paste functionality for that key
		1268	combination, and the second reinstates the default behaviour for
		1269	C<Control-Shift-Insert>, which would otherwise be overridden.
		1270
		1271	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1272	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1273	this:
		1274
		1275	URxvt.keysym.C-M-c: builtin-string:
		1276	URxvt.keysym.C-M-v: builtin-string:
		1277
		1278	=item EXTENSION:STRING
		1279
		1280	An action of this form invokes the action B<STRING>, if any, provided
		1281	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1282	be loaded automatically if necessary.
		1283
		1284	Not all extensions define actions, but popular extensions that do
		1285	include the I<selection> and I<matcher> extensions (documented in their
		1286	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1287	respectively).
		1288
		1289	From the silly examples department, this will rot13-"encrypt"
		1290	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1291	keyboards:
		1292
		1293	URxvt.keysym.M-C-c: selection:rot13
		1294
		1295	=item perl:STRING DEPRECATED
		1296
		1297	This is a deprecated way of invoking commands provided by perl
		1298	extensions. It is still supported, but should not be used anymore.
		1299
		1300	=back
1178		1301
1179	=item B<perl-ext-common>: I<string>	1302	=item B<perl-ext-common>: I<string>
1180		1303
1181	=item B<perl-ext>: I<string>	1304	=item B<perl-ext>: I<string>
1182		1305
1183	Comma-separated list(s) of perl extension scripts (default: C<default>) to	1306	Comma-separated list(s) of perl extension scripts (default: C<default>) to
1184	use in this terminal instance; option B<-pe>.	1307	use in this terminal instance; option B<-pe>.
1185		1308
1186	Extension names can be prefixed with a C<-> sign to prohibit using	1309	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	1310	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	1311	disable some extensions loaded by default, or specified via the
1189	example, C<default,-selection> will use all the default extension except	1312	C<perl-ext-common> resource. For example, C<default,-selection> will use
1190	C<selection>.	1313	all the default extensions except C<selection>.
1191		1314
1192	Extension names can also be followed by an argument in angle brackets	1315	To prohibit autoloading of extensions, you can prefix them with C</>,
1193	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1316	which will make urxvt refuse to automatically load them (this can be
1194	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1317	overridden, however, by specifying the extension name again without a
1195	multiple times with different arguments will pass multiple arguments to	1318	prefix, though). This does not prohibit extensions themselves loading
1196	the extension.	1319	other extensions. For example, C<default,/background> will keep the
		1320	C<background> extension from being loaded when a background OSC sequence
		1321	is received.
		1322
		1323	The default set includes the C<selection>, C<option-popup>,
		1324	C<selection-popup>, C<readline>, C<searchable-scrollback> and
		1325	C<confirm-paste> extensions, as well as any extensions which are mentioned
		1326	in B<keysym> resources.
		1327
		1328	Any extension such that a corresponding resource is given on the
		1329	command line is automatically appended to B<perl-ext>.
1197		1330
1198	Each extension is looked up in the library directories, loaded if	1331	Each extension is looked up in the library directories, loaded if
1199	necessary, and bound to the current terminal instance.	1332	necessary, and bound to the current terminal instance. When the library
		1333	search path contains multiple extension files of the same name, then the
		1334	first one found will be used.
1200		1335
1201	If both of these resources are the empty string, then the perl	1336	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	1337	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	1338	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.	1339	all instances, while B<perl-ext> is used for specific instances.
1205		1340
1206	=item B<perl-eval>: I<string>	1341	=item B<perl-eval>: I<string>
1207		1342
1208	Perl code to be evaluated when all extensions have been registered. See	1343	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	1344	the @@RXVT_NAME@@perl(3) manpage.
1210	will be ignored when running setuid/setgid.
1211		1345
1212	=item B<perl-lib>: I<path>	1346	=item B<perl-lib>: I<path>
1213		1347
1214	Colon-separated list of additional directories that hold extension	1348	Colon-separated list of additional directories that hold extension
1215	scripts. When looking for extensions specified by the C<perl> resource,	1349	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1216	@@RXVT_NAME@@ will first look in these directories and then in	1350	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	1351	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1218	will be ignored when running setuid/setgid.
1219		1352
1220	See the @@RXVT_NAME@@perl(3) manpage.	1353	See the @@RXVT_NAME@@perl(3) manpage.
1221		1354
1222	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1355	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1223		1356
…		…
1227	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1360	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1228		1361
1229	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1362	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1230	for details.	1363	for details.
1231		1364
1232	=item B<searchable-scrollback:> I<keysym>	1365	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1233		1366
1234	Sets the hotkey that starts the incremental scrollback buffer search	1367	This resource is deprecated and will be removed. Use a B<keysym> resource
1235	(default: C<M-s>).	1368	instead, e.g.:
1236		1369
		1370	URxvt.keysym.M-s: searchable-scrollback:start
		1371
1237	=item B<urlLauncher>: I<string>	1372	=item B<url-launcher>: I<string>
1238		1373
1239	Specifies the program to be started with a URL argument. Used by the	1374	Specifies the program to be started with a URL argument. Used by the
1240	C<selection-popup> and C<matcher> perl extensions.	1375	C<selection-popup> and C<matcher> perl extensions.
1241		1376
1242	=item B<transient-for>: I<windowid>	1377	=item B<transient-for>: I<windowid>
…		…
1245		1380
1246	=item B<override-redirect>: I<boolean>	1381	=item B<override-redirect>: I<boolean>
1247		1382
1248	Compile I<frills>: Sets override-redirect for the terminal window, making	1383	Compile I<frills>: Sets override-redirect for the terminal window, making
1249	it almost invisible to window managers; option B<-override-redirect>.	1384	it almost invisible to window managers; option B<-override-redirect>.
		1385
		1386	=item B<iso14755:> I<boolean>
		1387
		1388	Turn on/off ISO 14755 (default enabled).
1250		1389
1251	=item B<iso14755_52:> I<boolean>	1390	=item B<iso14755_52:> I<boolean>
1252		1391
1253	Turn on/off ISO 14755 5.2 mode (default enabled).	1392	Turn on/off ISO 14755 5.2 mode (default enabled).
1254		1393
…		…
1282	=head1 THE SELECTION: SELECTING AND PASTING TEXT	1421	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1283		1422
1284	The behaviour of text selection and insertion/pasting mechanism is similar	1423	The behaviour of text selection and insertion/pasting mechanism is similar
1285	to I<xterm>(1).	1424	to I<xterm>(1).
1286		1425
1287	=over 4	1426	=over
1288		1427
1289	=item B<Selecting>:	1428	=item B<Selecting>:
1290		1429
1291	Left click at the beginning of the region, drag to the end of the region	1430	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	1431	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.	1446	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1308		1447
1309	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1448	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1310	inserted too.	1449	inserted too.
1311		1450
		1451	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1452	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1453	binding causes the value of the internal selection to be copied to the
		1454	CLIPBOARD selection, while the second binding causes the value of the
		1455	CLIPBOARD selection to be inserted.
		1456
1312	=back	1457	=back
1313		1458
1314	=head1 CHANGING FONTS	1459	=head1 CHANGING FONTS
1315		1460
1316	Changing fonts (or font sizes, respectively) via the keypad is not yet	1461	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	1478	and character codes using the keyboard. It consists of 4 parts. The
1334	first part is available if rxvt-unicode has been compiled with	1479	first part is available if rxvt-unicode has been compiled with
1335	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1480	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1336	with C<--enable-iso14755>.	1481	with C<--enable-iso14755>.
1337		1482
1338	=over 4	1483	=over
1339		1484
1340	=item * 5.1: Basic method	1485	=item * 5.1: Basic method
1341		1486
1342	This allows you to enter unicode characters using their hexcode.	1487	This allows you to enter unicode characters using their hexcode.
1343		1488
…		…
1397	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1542	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	1543	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	1544	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.	1545	on some systems or setgid to root or to some other group on others.
1401		1546
1402	=head1 COLORS AND GRAPHICS	1547	=head1 COLOURS AND GRAPHICS
1403		1548
1404	In addition to the default foreground and background colours,	1549	In addition to the default foreground and background colours,
1405	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1550	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	1551	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1407	colours with their names.	1552	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1553	cube plus a 8 (24) colour greyscale ramp.
		1554
		1555	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1556	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1557	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1558	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1559	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1560	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1561	use many similar 24-bit colours. It's typically not a problem in common
		1562	scenarios.
		1563
		1564	Here is a list of the ANSI colours with their names.
1408		1565
1409	=begin table	1566	=begin table
1410		1567
1411	B<color0> (black) = Black	1568	B<color0> (black) = Black
1412	B<color1> (red) = Red3	1569	B<color1> (red) = Red3
…		…
1432	It is also possible to specify the colour values of B<foreground>,	1589	It is also possible to specify the colour values of B<foreground>,
1433	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1590	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	1591	a number 0-15, as a convenient shorthand to reference the colour name of
1435	color0-color15.	1592	color0-color15.
1436		1593
1437	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1594	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)	1595	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		1596
		1597	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1598
		1599	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1600	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1601
		1602	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1603	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1604	the RGB cube.
		1605
1442	Together, all those colours implement the 88 colour xterm colours. Only	1606	Together, all those colours implement the 88 (256) colour xterm
1443	the first 16 can be changed using resources currently, the rest can only	1607	colours. Only the first 16 can be changed using resources currently, the
1444	be changed via command sequences ("escape codes").	1608	rest can only be changed via command sequences ("escape codes").
		1609
		1610	Applications are advised to use terminfo or command sequences to discover
		1611	number and RGB values of all colours (yes, you can query this...).
1445		1612
1446	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1613	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1447	always swapping the foreground/background colours. This is in contrast to	1614	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	1615	I<xterm>(1) where the colours are only swapped if they have not otherwise
1449	been specified. For example,	1616	been specified. For example,
1450		1617
1451	=over 4
1452
1453	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1618	@@RXVT_NAME@@ -fg Black -bg White -rv
1454		1619
1455	would yield White on Black, while on I<xterm>(1) it would yield Black	1620	would yield White on Black, while on I<xterm>(1) it would yield Black on
1456	on White.	1621	White.
1457
1458	=back
1459		1622
1460	=head2 ALPHA CHANNEL SUPPORT	1623	=head2 ALPHA CHANNEL SUPPORT
1461		1624
1462	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1625	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>	1626	their act together, rxvt-unicode will do its own alpha channel management:
1464	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1627
1465	in addition to the ones provided by X, where the additional A component	1628	You can prefix any colour with an opaqueness percentage enclosed in
		1629	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1630	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1631	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1632	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1633	is the recommended format to specify transparency values, and works with
		1634	all ways to specify a colour.
		1635
		1636	For complete control, rxvt-unicode also supports
		1637	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1638	specifications, where the additional C<aaaa> component specifies opacity
1466	specifies opacity (alpha) values. The minimum value of C<0> is completely	1639	(alpha) values. The minimum value of C<0000> is completely transparent,
1467	transparent). You can also prefix any color with C<[percent]>, where	1640	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	1641	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	1642	C<rgba:0000/ff00/0000/f332>.
1470	opaque.
1471		1643
1472	You probably need to specify B<"-depth 32">, too, and have the luck that	1644	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	1645	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.	1646	layout, as X is far from just supporting ARGB visuals out of the box, and
		1647	rxvt-unicode just fudges around.
1475		1648
1476	For example, the following selects an almost completely transparent red	1649	For example, the following selects an almost completely transparent black
1477	background, and an almost opaque pink foreground:	1650	background, and an almost opaque pink foreground:
1478		1651
1479	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1652	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1480		1653
1481	I<Please note that transparency of any kind if completely unsupported by	1654	When not using a background image, then the interpretation of the
1482	the author. Don't bug him with installation questions!>	1655	alpha channel is up to your compositing manager (most interpret it as
		1656	transparency of course).
		1657
		1658	When using a background pixmap or pseudo-transparency, then the background
		1659	colour will always behave as if it were completely transparent (so the
		1660	background image shows instead), regardless of how it was specified, while
		1661	other colours will either be transparent as specified (the background
		1662	image will show through) on servers supporting the RENDER extension, or
		1663	fully opaque on servers not supporting the RENDER EXTENSION.
		1664
		1665	Please note that due to bugs in Xft, specifying alpha values might result
		1666	in garbage being displayed when the X-server does not support the RENDER
		1667	extension.
1483		1668
1484	=head1 ENVIRONMENT	1669	=head1 ENVIRONMENT
1485		1670
1486	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1671	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1487		1672
1488	=over 4	1673	=over
1489		1674
1490	=item B<TERM>	1675	=item B<TERM>
1491		1676
1492	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1677	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1493	resources or on the command line.	1678	resources or on the command line.
…		…
1521	C<--with-terminfo=PATH>.	1706	C<--with-terminfo=PATH>.
1522		1707
1523	=item B<DISPLAY>	1708	=item B<DISPLAY>
1524		1709
1525	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1710	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1526	display in its child processes.	1711	display in its child processes if C<-display> isn't used to override. It
		1712	defaults to C<:0> if it doesn't exist.
1527		1713
1528	=item B<SHELL>	1714	=item B<SHELL>
1529		1715
1530	The shell to be used for command execution, defaults to C</bin/sh>.	1716	The shell to be used for command execution, defaults to C</bin/sh>.
1531		1717
1532	=item B<RXVT_SOCKET>	1718	=item B<RXVT_SOCKET> [I<sic>]
1533		1719
1534	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1720	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1535	@@RXVT_NAME@@d(1).	1721	@@RXVT_NAME@@d(1).
1536		1722
1537	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1723	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1724
		1725	=item B<URXVT_PERL_LIB>
		1726
		1727	Additional F<:>-separated library search path for perl extensions. Will be
		1728	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1729	directory.
		1730
		1731	=item B<URXVT_PERL_VERBOSITY>
		1732
		1733	See L<@@RXVT_NAME@@perl>(3).
1538		1734
1539	=item B<HOME>	1735	=item B<HOME>
1540		1736
1541	Used to locate the default directory for the unix domain socket for	1737	Used to locate the default directory for the unix domain socket for
1542	daemon communications and to locate various resource files (such as	1738	daemon communications and to locate various resource files (such as
1543	C<.Xdefaults>)	1739	C<.Xdefaults>)
1544		1740
1545	=item B<XAPPLRESDIR>	1741	=item B<XAPPLRESDIR>
1546		1742
1547	Directory where various X resource files are being located.	1743	Directory where application-specific X resource files are located.
1548		1744
1549	=item B<XENVIRONMENT>	1745	=item B<XENVIRONMENT>
1550		1746
1551	If set and accessible, gives the name of a X resource file to be loaded by	1747	If set and accessible, gives the name of a X resource file to be loaded by
1552	@@RXVT_NAME@@.	1748	@@RXVT_NAME@@.
1553		1749
1554	=back	1750	=back
1555		1751
1556	=head1 FILES	1752	=head1 FILES
1557		1753
1558	=over 4	1754	=over
1559		1755
1560	=item B</usr/lib/X11/rgb.txt>	1756	=item B</usr/lib/X11/rgb.txt>
1561		1757
1562	Color names.	1758	Colour names.
1563		1759
1564	=back	1760	=back
1565		1761
1566	=head1 SEE ALSO	1762	=head1 SEE ALSO
1567		1763
		1764	@@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)	1765	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1569		1766
1570	=head1 CURRENT PROJECT COORDINATOR	1767	=head1 CURRENT PROJECT COORDINATOR
1571		1768
1572	=over 4	1769	=over
1573		1770
1574	=item Project Coordinator	1771	=item Project Coordinator
1575		1772
1576	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1773	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1577		1774
1578	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1775	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1579		1776
1580	=back	1777	=back
1581		1778
1582	=head1 AUTHORS	1779	=head1 AUTHORS
1583		1780
1584	=over 4	1781	=over
1585		1782
1586	=item John Bovey	1783	=item John Bovey
1587		1784
1588	University of Kent, 1992, wrote the original Xvt.	1785	University of Kent, 1992, wrote the original Xvt.
1589		1786
1590	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1787	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1591		1788
1592	very heavily modified Xvt and came up with Rxvt	1789	very heavily modified Xvt and came up with Rxvt
1593		1790
1594	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1791	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1595		1792
1596	wrote the Greek Keyboard Input (no longer in code)	1793	wrote the Greek Keyboard Input (no longer in code)
1597		1794
1598	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1795	=item mj olesen <olesen@me.QueensU.CA>
1599		1796
1600	Wrote the menu system.	1797	Wrote the menu system.
1601		1798
1602	Project Coordinator (changes.txt 2.11 to 2.21)	1799	Project Coordinator (changes.txt 2.11 to 2.21)
1603		1800
1604	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1801	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1605		1802
1606	Project Coordinator (changes.txt 2.21a to 2.4.5)	1803	Project Coordinator (changes.txt 2.21a to 2.4.5)
1607		1804
1608	=item Geoff Wing L<< <gcw@pobox.com> >>	1805	=item Geoff Wing <gcw@pobox.com>
1609		1806
1610	Rewrote screen display and text selection routines.	1807	Rewrote screen display and text selection routines.
1611		1808
1612	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1809	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1613		1810
1614	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1811	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1615		1812
1616	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1813	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1617	extension, random hacks, numerous bugfixes and extensions.	1814	extension, random hacks, numerous bugfixes and extensions.
1618		1815
1619	Project Coordinator (Changes 1.0 -)	1816	Project Coordinator (Changes 1.0 -)
1620		1817
1621	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1818	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1622		1819
1623	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1820	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1624		1821
1625	=back	1822	=back
1626		1823

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.259 by sf-exg, Sun Dec 19 20:48:21 2021 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.259 by sf-exg, Sun Dec 19 20:48:21 2021 UTC