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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs. Revision 1.251 by root, Sat Jul 3 04:04:12 2021 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs.
Revision 1.251 by root, Sat Jul 3 04:04:12 2021 UTC