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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC vs.
Revision 1.236 by sf-exg, Sat Aug 16 10:51:23 2014 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC vs. Revision 1.236 by sf-exg, Sat Aug 16 10:51:23 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC vs.
Revision 1.236 by sf-exg, Sat Aug 16 10:51:23 2014 UTC