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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC vs.
Revision 1.221 by sf-exg, Mon Nov 5 12:59:13 2012 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/checkout/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>).
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
…		…
242		233
243	=item B<-sb>\|B<+sb>	234	=item B<-sb>\|B<+sb>
244		235
245	Turn on/off scrollbar; resource B<scrollBar>.	236	Turn on/off scrollbar; resource B<scrollBar>.
246		237
		238	=item B<-sr>\|B<+sr>
		239
		240	Put scrollbar on right/left; resource B<scrollBar_right>.
		241
		242	=item B<-st>\|B<+st>
		243
		244	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		245	resource B<scrollBar_floating>.
		246
247	=item B<-si>\|B<+si>	247	=item B<-si>\|B<+si>
248		248
249	Turn on/off scroll-to-bottom on TTY output inhibit; resource	249	Turn on/off scroll-to-bottom on TTY output inhibit; resource
250	B<scrollTtyOutput> has opposite effect.	250	B<scrollTtyOutput> has opposite effect.
251		251
…		…
257	=item B<-sw>\|B<+sw>	257	=item B<-sw>\|B<+sw>
258		258
259	Turn on/off scrolling with the scrollback buffer as new lines appear.	259	Turn on/off scrolling with the scrollback buffer as new lines appear.
260	This only takes effect if B<-si> is also given; resource	260	This only takes effect if B<-si> is also given; resource
261	B<scrollWithBuffer>.	261	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		262
272	=item B<-ptab>\|B<+ptab>	263	=item B<-ptab>\|B<+ptab>
273		264
274	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
275	actual wide characters in the screen buffer, which makes it possible to	266	actual wide characters in the screen buffer, which makes it possible to
…		…
279		270
280	=item B<-bc>\|B<+bc>	271	=item B<-bc>\|B<+bc>
281		272
282	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
283		274
		275	=item B<-uc>\|B<+uc>
		276
		277	Make the cursor underlined; resource B<cursorUnderline>.
		278
284	=item B<-iconic>	279	=item B<-iconic>
285		280
286	Start iconified, if the window manager supports that option.	281	Start iconified, if the window manager supports that option.
287	Alternative form is B<-ic>.	282	Alternative form is B<-ic>.
288		283
…		…
304		299
305	=item B<-bl>	300	=item B<-bl>
306		301
307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	302	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	303	if honoured by the WM, the rxvt-unicode window will not have window
309	decorations; resource B<borderLess>.	304	decorations; resource B<borderLess>. If the window manager does not
		305	support MWM hints (e.g. kwin), enables override-redirect mode.
310		306
311	=item B<-override-redirect>	307	=item B<-override-redirect>
312		308
313	Compile I<frills>: Sets override-redirect on the window; resource	309	Compile I<frills>: Sets override-redirect on the window; resource
314	B<override-redirect>.	310	B<override-redirect>.
…		…
322		318
323	=item B<-lsp> I<number>	319	=item B<-lsp> I<number>
324		320
325	Compile I<frills>: Lines (pixel height) to insert between each row of	321	Compile I<frills>: Lines (pixel height) to insert between each row of
326	the display. Useful to work around font rendering problems; resource	322	the display. Useful to work around font rendering problems; resource
327	B<linespace>.	323	B<lineSpace>.
		324
		325	=item B<-letsp> I<number>
		326
		327	Compile I<frills>: Amount to adjust the computed character width by
		328	to control overall letter spacing. Negative values will tighten up the
		329	letter spacing, positive values will space letters out more. Useful to
		330	work around odd font metrics; resource B<letterSpace>.
328		331
329	=item B<-tn> I<termname>	332	=item B<-tn> I<termname>
330		333
331	This option specifies the name of the terminal type to be set in the	334	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	335	B<TERM> environment variable. This terminal type must exist in the
…		…
386	for more info.	389	for more info.
387		390
388	=item B<-tcw>	391	=item B<-tcw>
389		392
390	Change the meaning of triple-click selection with the left mouse	393	Change the meaning of triple-click selection with the left mouse
		394	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	395	in-use. Instead of selecting a full line it will extend the selection to
392	end of the logical line only. resource B<tripleclickwords>.	396	the end of the logical line only. resource B<tripleclickwords>.
393		397
394	=item B<-insecure>	398	=item B<-insecure>
395		399
396	Enable "insecure" mode, which currently enables most of the escape	400	Enable "insecure" mode, which currently enables most of the escape
397	sequences that echo strings. See the resource B<insecure> for more	401	sequences that echo strings. See the resource B<insecure> for more
…		…
417		421
418	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	422	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419	will not immediately destroy its window when the program executed within	423	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	424	it exits. Instead, it will wait till it is being killed or closed by the
421	user; resource B<hold>.	425	user; resource B<hold>.
		426
		427	=item B<-cd> I<path>
		428
		429	Sets the working directory for the shell (or the command specified via
		430	B<-e>). The I<path> must be an absolute path and it must exist for
		431	@@RXVT_NAME@@ to start; resource B<chdir>.
		432
		433	=item B<-xrm> I<string>
		434
		435	Works like the X Toolkit option of the same name, by adding the I<string>
		436	as if it were specified in a resource file. Resource values specified this
		437	way take precedence over all other resource specifications.
		438
		439	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		440	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		441	options can be specified as long-options on the commandline, so use
		442	of B<-xrm> is mostly limited to cases where you want to specify other
		443	resources (e.g. for input methods) or for compatibility with other
		444	programs.
422		445
423	=item B<-keysym.>I<sym> I<string>	446	=item B<-keysym.>I<sym> I<string>
424		447
425	Remap a key symbol. See resource B<keysym>.	448	Remap a key symbol. See resource B<keysym>.
426		449
…		…
461	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	484	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	485	entries and will not tinker with pty/tty permissions - you have to do that
463	yourself if you want that.	486	yourself if you want that.
464		487
465	As an extremely special case, specifying C<-1> will completely suppress	488	As an extremely special case, specifying C<-1> will completely suppress
466	pty/tty operations.	489	pty/tty operations, which is probably only useful in conjunction with some
		490	perl extension that manages the terminal.
467		491
468	Here is a example in perl that illustrates how this option can be used (a	492	Here is a example in perl that illustrates how this option can be used (a
469	longer example is in F<doc/pty-fd>):	493	longer example is in F<doc/pty-fd>):
470		494
471	use IO::Pty;	495	use IO::Pty;
…		…
485	Comma-separated list of perl extension scripts to use (or not to use) in	509	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.	510	this terminal instance. See resource B<perl-ext> for details.
487		511
488	=back	512	=back
489		513
490	=head1 RESOURCES (available also as long-options)	514	=head1 RESOURCES
491		515
492	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	516	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493	options) compiled into your version.	517	options) compiled into your version. All resources are also available as
		518	long-options.
494		519
495	You can set and change the resources using X11 tools like B<xrdb>. Many	520	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	521	distribution do also load settings from the B<~/.Xresources> file when X
497	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498	with later settings overwriting earlier ones:	523	with later settings overwriting earlier ones:
499		524
500	1. system-wide app-defaults file, either locale-dependent OR global
501	2. app-defaults file in $XAPPLRESDIR	525	1. app-defaults file in $XAPPLRESDIR
		526	2. $HOME/.Xdefaults
502	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	527	3. RESOURCE_MANAGER property on root-window of screen 0
503	4. SCREEN_RESOURCES for the current screen	528	4. SCREEN_RESOURCES property on root-window of the current screen
504	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		530	6. resources specified via -xrm on the commandline
505		531
506	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	532	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	533	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	534	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	535	configured, while the class name B<URxvt> allows resources unique to
…		…
519	=item B<depth:> I<bitdepth>	545	=item B<depth:> I<bitdepth>
520		546
521	Compile I<xft>: Attempt to find a visual with the given bit depth;	547	Compile I<xft>: Attempt to find a visual with the given bit depth;
522	option B<-depth>.	548	option B<-depth>.
523		549
		550	=item B<buffered:> I<boolean>
		551
		552	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		553	On some card/driver combination enabling it slightly decreases
		554	performance, on most it greatly helps it. The slowdown is small, so it
		555	should normally be enabled.
		556
524	=item B<geometry:> I<geom>	557	=item B<geometry:> I<geom>
525		558
526	Create the window with the specified X window geometry [default 80x24];	559	Create the window with the specified X window geometry [default 80x24];
527	option B<-geometry>.	560	option B<-geometry>.
528		561
…		…
541	Use the specified colour for the colour value I<n>, where 0-7	574	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	575	corresponds to low-intensity (normal) colours and 8-15 corresponds to
543	high-intensity (bold = bright foreground, blink = bright background)	576	high-intensity (bold = bright foreground, blink = bright background)
544	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	577	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	578	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.	579	names used are listed in the B<COLOURS AND GRAPHICS> section.
547		580
548	Colours higher than 15 cannot be set using resources (yet), but can be	581	Colours higher than 15 cannot be set using resources (yet), but can be
549	changed using an escape command (see @@RXVT_NAME@@(7)).	582	changed using an escape command (see @@RXVT_NAME@@(7)).
550		583
551	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	584	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
562	=item B<colorUL:> I<colour>	595	=item B<colorUL:> I<colour>
563		596
564	Use the specified colour to display underlined characters when the	597	Use the specified colour to display underlined characters when the
565	foreground colour is the default.	598	foreground colour is the default.
566		599
567	=item B<colorRV:> I<colour>
568
569	Use the specified colour as the background for reverse video
570	characters.
571
572	=item B<underlineColor:> I<colour>	600	=item B<underlineColor:> I<colour>
573		601
574	If set, use the specified colour as the colour for the underline	602	If set, use the specified colour as the colour for the underline
575	itself. If unset, use the foreground colour.	603	itself. If unset, use the foreground colour.
		604
		605	=item B<highlightColor:> I<colour>
		606
		607	If set, use the specified colour as the background for highlighted
		608	characters. If unset, use reverse video.
		609
		610	=item B<highlightTextColor:> I<colour>
		611
		612	If set and highlightColor is set, use the specified colour as the
		613	foreground for highlighted characters.
576		614
577	=item B<cursorColor:> I<colour>	615	=item B<cursorColor:> I<colour>
578		616
579	Use the specified colour for the cursor. The default is to use the	617	Use the specified colour for the cursor. The default is to use the
580	foreground colour; option B<-cr>.	618	foreground colour; option B<-cr>.
…		…
587		625
588	=item B<reverseVideo:> I<boolean>	626	=item B<reverseVideo:> I<boolean>
589		627
590	B<True>: simulate reverse video by foreground and background colours;	628	B<True>: simulate reverse video by foreground and background colours;
591	option B<-rv>. B<False>: regular screen colours [default]; option	629	option B<-rv>. B<False>: regular screen colours [default]; option
592	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	630	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593		631
594	=item B<jumpScroll:> I<boolean>	632	=item B<jumpScroll:> I<boolean>
595		633
596	B<True>: specify that jump scrolling should be used. When scrolling	634	B<True>: specify that jump scrolling should be used. When receiving lots
597	quickly, fewer screen updates are performed [default]; option B<-j>.	635	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		636	has been read, resulting in fewer updates while still displaying every
		637	received line; option B<-j>.
		638
598	B<False>: specify that smooth scrolling should be used; option B<+j>.	639	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		640	force a screen refresh on each new line it received; option B<+j>.
599		641
600	=item B<inheritPixmap:> I<boolean>	642	=item B<skipScroll:> I<boolean>
601		643
602	B<True>: make the background inherit the parent windows' pixmap, giving	644	B<True>: (the default) specify that skip scrolling should be used. When
603	artificial transparency. B<False>: do not inherit the parent windows'	645	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604	pixmap.	646	(around 60 times per second), resulting in far fewer updates. This can
		647	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		648	option B<-ss>.
605		649
606	I<Please note that transparency of any kind if completely unsupported by	650	B<False>: specify that everything is to be displayed, even
607	the author. Don't bug him with installation questions!>	651	if the refresh is too fast for the human eye to read anything (or the
		652	monitor to display anything); option B<+ss>.
608		653
609	=item B<fading:> I<number>	654	=item B<fading:> I<number>
610		655
611	Fade the text by the given percentage when focus is lost; option B<-fade>.	656	Fade the text by the given percentage when focus is lost; option B<-fade>.
612		657
613	=item B<fadeColor:> I<colour>	658	=item B<fadeColor:> I<colour>
614		659
615	Fade to this colour, when fading is used (see B<fading:>). The default	660	Fade to this colour, when fading is used (see B<fading:>). The default
616	colour is black; option B<-fadecolor>.	661	colour is black; option B<-fadecolor>.
617		662
618	=item B<tintColor:> I<colour>	663	=item B<iconFile:> I<file>
619		664
620	Tint the transparent background pixmap with the given colour; option	665	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
626	image in addition to tinting it.
627		666
628	=item B<scrollColor:> I<colour>	667	=item B<scrollColor:> I<colour>
629		668
630	Use the specified colour for the scrollbar [default #B2B2B2].	669	Use the specified colour for the scrollbar [default #B2B2B2].
631		670
…		…
636		675
637	=item B<borderColor:> I<colour>	676	=item B<borderColor:> I<colour>
638		677
639	The colour of the border around the text area and between the scrollbar	678	The colour of the border around the text area and between the scrollbar
640	and the text.	679	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		680
658	=item B<font:> I<fontlist>	681	=item B<font:> I<fontlist>
659		682
660	Select the fonts to be used. This is a comma separated list of font names	683	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	684	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	707	it is named first) and thus defines the character cell grid to be 9 pixels
685	wide and 15 pixels high.	708	wide and 15 pixels high.
686		709
687	The second font is just used to add additional unicode characters not in	710	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	711	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	712	the bold version of the font does contain fewer characters, so this is a
690	useful supplement.	713	useful supplement.
691		714
692	The third font is an Xft font with aliasing turned off, and the characters	715	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	716	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.	717	contains other characters, but we are not interested in them.
…		…
718	text font will being used for the given style.	741	text font will being used for the given style.
719		742
720	=item B<intensityStyles:> I<boolean>	743	=item B<intensityStyles:> I<boolean>
721		744
722	When font styles are not enabled, or this option is enabled (B<True>,	745	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	746	option B<-is>, the default), bold/blink font styles imply high
724	intensity foreground/background colours. Disabling this option (B<False>,	747	intensity foreground/background colours. Disabling this option (B<False>,
725	option B<+is>) disables this behaviour, the high intensity colours are not	748	option B<+is>) disables this behaviour, the high intensity colours are not
726	reachable.	749	reachable.
727		750
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>	751	=item B<title:> I<string>
740		752
741	Set window title string, the default title is the command-line	753	Set window title string, the default title is the command-line
742	specified after the B<-e> option, if any, otherwise the application	754	specified after the B<-e> option, if any, otherwise the application
743	name; option B<-title>.	755	name; option B<-title>.
…		…
751	=item B<mapAlert:> I<boolean>	763	=item B<mapAlert:> I<boolean>
752		764
753	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	765	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754	de-iconify (map) on receipt of a bell character [default].	766	de-iconify (map) on receipt of a bell character [default].
755		767
		768	=item B<urgentOnBell:> I<boolean>
		769
		770	B<True>: set the urgency hint for the wm on receipt of a bell character.
		771	B<False>: do not set the urgency hint [default].
		772
		773	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		774
756	=item B<visualBell:> I<boolean>	775	=item B<visualBell:> I<boolean>
757		776
758	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	777	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759	B<False>: no visual bell [default]; option B<+vb>.	778	B<False>: no visual bell [default]; option B<+vb>.
760		779
…		…
783	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	802	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784		803
785	This creates a new file in your home directory with the screen contents	804	This creates a new file in your home directory with the screen contents
786	every time you hit C<Print>.	805	every time you hit C<Print>.
787		806
		807	=item B<scrollstyle:> I<mode>
		808
		809	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		810	the author's favourite.
		811
		812	=item B<thickness:> I<number>
		813
		814	Set the scrollbar width in pixels.
		815
788	=item B<scrollBar:> I<boolean>	816	=item B<scrollBar:> I<boolean>
789		817
790	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	818	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791	disable the scrollbar; option B<+sb>.	819	disable the scrollbar; option B<+sb>.
792		820
…		…
811	B<False>: do not scroll to bottom when tty receives output; option	839	B<False>: do not scroll to bottom when tty receives output; option
812	B<+si>.	840	B<+si>.
813		841
814	=item B<scrollWithBuffer:> I<boolean>	842	=item B<scrollWithBuffer:> I<boolean>
815		843
816	B<True>: scroll with scrollback buffer when tty receives new lines (and	844	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
817	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	845	try to show the same lines) and B<scrollTtyOutput> is False; option
818	with scrollback buffer when tty receives new lines; option B<+sw>.	846	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		847	new lines; option B<+sw>.
819		848
820	=item B<scrollTtyKeypress:> I<boolean>	849	=item B<scrollTtyKeypress:> I<boolean>
821		850
822	B<True>: scroll to bottom when a non-special key is pressed. Special keys	851	B<True>: scroll to bottom when a non-special key is pressed. Special keys
823	are those which are intercepted by rxvt-unicode for special handling and	852	are those which are intercepted by rxvt-unicode for special handling and
…		…
854	=item B<termName:> I<termname>	883	=item B<termName:> I<termname>
855		884
856	Specifies the terminal type name to be set in the B<TERM> environment	885	Specifies the terminal type name to be set in the B<TERM> environment
857	variable; option B<-tn>.	886	variable; option B<-tn>.
858		887
859	=item B<linespace:> I<number>	888	=item B<lineSpace:> I<number>
860		889
861	Specifies number of lines (pixel height) to insert between each row of	890	Specifies number of lines (pixel height) to insert between each row of
862	the display [default 0]; option B<-lsp>.	891	the display [default 0]; option B<-lsp>.
863		892
864	=item B<meta8:> I<boolean>	893	=item B<meta8:> I<boolean>
…		…
878		907
879	=item B<cursorBlink:> I<boolean>	908	=item B<cursorBlink:> I<boolean>
880		909
881	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	910	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
882	option B<-bc>.	911	option B<-bc>.
		912
		913	=item B<cursorUnderline:> I<boolean>
		914
		915	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		916	option B<-uc>.
883		917
884	=item B<pointerBlank:> I<boolean>	918	=item B<pointerBlank:> I<boolean>
885		919
886	B<True>: blank the pointer when a key is pressed or after a set number	920	B<True>: blank the pointer when a key is pressed or after a set number
887	of seconds of inactivity. B<False>: the pointer is always visible	921	of seconds of inactivity. B<False>: the pointer is always visible
…		…
901	large number (e.g. C<987654321>) to effectively disable the timeout.	935	large number (e.g. C<987654321>) to effectively disable the timeout.
902		936
903	=item B<backspacekey:> I<string>	937	=item B<backspacekey:> I<string>
904		938
905	The string to send when the backspace key is pressed. If set to B<DEC>	939	The string to send when the backspace key is pressed. If set to B<DEC>
906	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	940	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
907	(code 8) - which can be reversed with the appropriate DEC private mode	941	(code 8) - which can be reversed with the appropriate DEC private mode
908	escape sequence.	942	escape sequence.
909		943
910	=item B<deletekey:> I<string>	944	=item B<deletekey:> I<string>
911		945
…		…
916	=item B<cutchars:> I<string>	950	=item B<cutchars:> I<string>
917		951
918	The characters used as delimiters for double-click word selection	952	The characters used as delimiters for double-click word selection
919	(whitespace delimiting is added automatically if resource is given).	953	(whitespace delimiting is added automatically if resource is given).
920		954
921	When the selection extension is in use (the default if compiled in, see	955	When the perl selection extension is in use (the default if compiled
922	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	956	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923	will be created (if the resource exists, otherwise, no regex will be	957	characters will be created (if the resource exists, otherwise, no regex
924	created). In this mode, characters outside ISO-8859-1 can be used.	958	will be created). In this mode, characters outside ISO-8859-1 can be used.
925		959
926	When the selection extension is not used, only ISO-8859-1 characters can	960	When the selection extension is not used, only ISO-8859-1 characters can
927	be used. If not specified, the built-in default is used:	961	be used. If not specified, the built-in default is used:
928		962
929	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	963	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
930		964
931	=item B<preeditType:> I<style>	965	=item B<preeditType:> I<style>
932		966
933	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	967	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934		968
…		…
988		1022
989	Turn on/off secondary screen (default enabled).	1023	Turn on/off secondary screen (default enabled).
990		1024
991	=item B<secondaryScroll:> I<boolean>	1025	=item B<secondaryScroll:> I<boolean>
992		1026
993	Turn on/off secondary screen scroll (default enabled). If the this	1027	Turn on/off secondary screen scroll (default enabled). If this
994	option is enabled, scrolls on the secondary screen will change the	1028	option is enabled, scrolls on the secondary screen will change the
995	scrollback buffer and switching to/from the secondary screen will	1029	scrollback buffer and, when secondaryScreen is off, switching
996	instead scroll the screen up.	1030	to/from the secondary screen will instead scroll the screen up.
997		1031
998	=item B<hold>: I<boolean>	1032	=item B<hold>: I<boolean>
999		1033
1000	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1034	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001	will not immediately destroy its window when the program executed within	1035	will not immediately destroy its window when the program executed within
1002	it exits. Instead, it will wait till it is being killed or closed by the	1036	it exits. Instead, it will wait till it is being killed or closed by the
1003	user.	1037	user.
		1038
		1039	=item B<chdir>: I<path>
		1040
		1041	Sets the working directory for the shell (or the command specified via
		1042	B<-e>). The I<path> must be an absolute path and it must exist for
		1043	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1044	directory will be used; option B<-cd>.
1004		1045
1005	=item B<keysym.>I<sym>: I<string>	1046	=item B<keysym.>I<sym>: I<string>
1006		1047
1007	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1048	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1008	intervening resource name B<keysym.> cannot be omitted.	1049	intervening resource name B<keysym.> cannot be omitted.
…		…
1022	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1063	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1023	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1064	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1024	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1065	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1025	performed in an exact manner; however, the closest match is assured.	1066	performed in an exact manner; however, the closest match is assured.
1026		1067
1027	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1068	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1028	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1069	number), see RESOURCES in C<man 7 X> for further details.
1029	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1030	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031	can start or end with whitespace.
1032		1070
1033	Please note that you need to double the C<\> in resource files, as
1034	Xlib itself does its own de-escaping (you can use C<\033> instead of
1035	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1036	processing).
1037
1038	You can define a range of keysyms in one shot by providing a I<string>	1071	You can define a range of keysyms in one shot by
		1072	loading the C<keysym-list> perl extension and providing a I<string>
1039	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1073	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1040	should be a character not used by the strings.	1074	should be a character not used by the strings.
1041		1075
1042	Its usage can be demonstrated by an example:	1076	Its usage can be demonstrated by an example:
1043		1077
1044	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1078	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1045		1079
1046	The above line is equivalent to the following three lines:	1080	The above line is equivalent to the following three lines:
1047		1081
1048	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1082	URxvt.keysym.Meta-Control-0x61: \033<a>
1049	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1083	URxvt.keysym.Meta-Control-0x62: \033<b>
1050	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1084	URxvt.keysym.Meta-Control-0x63: \033<c>
1051		1085
1052	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1086	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1053	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1087	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1054	example the following means "change the current locale to C<zh_CN.GBK>	1088	example the following means "change the current locale to C<zh_CN.GBK>
1055	when Control-Meta-c is being pressed":	1089	when Control-Meta-c is being pressed":
1056		1090
1057	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1091	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1058		1092
1059	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1093	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1060	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1094	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1061	manpage. For example, the F<selection> extension (activated via	1095	manpage. For example, the F<selection> extension (activated via
1062	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1096	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1063		1097
1064	URxvt.keysym.M-C-c: perl:selection:rot13	1098	URxvt.keysym.M-C-c: perl:selection:rot13
1065		1099
1066	Due the the large number of modifier combinations, a defined key mapping	1100	Due the the large number of modifier combinations, a defined key mapping
1067	will match if at I<at least> the specified identifiers are being set, and	1101	will match if I<at least> the specified identifiers are being set, and
1068	no other key mappings with those and more bits are being defined. That	1102	no other key mappings with those and more bits are being defined. That
1069	means that defining a key map for C<a> will automatically provide	1103	means that defining a key map for C<a> will automatically provide
1070	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1104	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1071	mappings themselves.	1105	mappings themselves.
1072		1106
…		…
1123	all instances, while B<perl-ext> is used for specific instances.	1157	all instances, while B<perl-ext> is used for specific instances.
1124		1158
1125	=item B<perl-eval>: I<string>	1159	=item B<perl-eval>: I<string>
1126		1160
1127	Perl code to be evaluated when all extensions have been registered. See	1161	Perl code to be evaluated when all extensions have been registered. See
1128	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1162	the @@RXVT_NAME@@perl(3) manpage.
1129	will be ignored when running setuid/setgid.
1130		1163
1131	=item B<perl-lib>: I<path>	1164	=item B<perl-lib>: I<path>
1132		1165
1133	Colon-separated list of additional directories that hold extension	1166	Colon-separated list of additional directories that hold extension
1134	scripts. When looking for extensions specified by the C<perl> resource,	1167	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1135	@@RXVT_NAME@@ will first look in these directories and then in	1168	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1136	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1169	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1137	will be ignored when running setuid/setgid.
1138		1170
1139	See the @@RXVT_NAME@@perl(3) manpage.	1171	See the @@RXVT_NAME@@perl(3) manpage.
1140		1172
1141	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1173	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1142		1174
…		…
1154	(default: C<M-s>).	1186	(default: C<M-s>).
1155		1187
1156	=item B<urlLauncher>: I<string>	1188	=item B<urlLauncher>: I<string>
1157		1189
1158	Specifies the program to be started with a URL argument. Used by the	1190	Specifies the program to be started with a URL argument. Used by the
1159	C<selection-popup> and C<mark-urls> perl extensions.	1191	C<selection-popup> and C<matcher> perl extensions.
1160		1192
1161	=item B<transient-for>: I<windowid>	1193	=item B<transient-for>: I<windowid>
1162		1194
1163	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1195	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164		1196
1165	=item B<override-redirect>: I<boolean>	1197	=item B<override-redirect>: I<boolean>
1166		1198
1167	Compile I<frills>: Sets override-redirect for the terminal window, making	1199	Compile I<frills>: Sets override-redirect for the terminal window, making
1168	it almost invisible to window managers; option B<-override-redirect>.	1200	it almost invisible to window managers; option B<-override-redirect>.
		1201
		1202	=item B<iso14755:> I<boolean>
		1203
		1204	Turn on/off ISO 14755 (default enabled).
		1205
		1206	=item B<iso14755_52:> I<boolean>
		1207
		1208	Turn on/off ISO 14755 5.2 mode (default enabled).
		1209
		1210	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1211
		1212	=item B<-pixmap> I<file[;oplist]>
		1213
		1214	=item B<backgroundPixmap:> I<file[;oplist]>
		1215
		1216	Compile I<pixbuf>: Use the specified image file as the window's
		1217	background and also optionally specify a colon separated list of
		1218	operations to modify it. Note that you may need to quote the C<;>
		1219	character when using the command line option, as C<;> is usually a
		1220	metacharacter in shells. Supported operations are:
		1221
		1222	=over 4
		1223
		1224	=item B<WxH+X+Y>
		1225
		1226	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1227	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1228	scale of 0 disables scaling.
		1229
		1230	=item B<op=tile>
		1231
		1232	enables tiling
		1233
		1234	=item B<op=keep-aspect>
		1235
		1236	maintain the image aspect ratio when scaling
		1237
		1238	=item B<op=root-align>
		1239
		1240	use the position of the terminal window relative to the root window as
		1241	the image offset, simulating a root window background
		1242
		1243	=back
		1244
		1245	The default scale and position setting is C<100x100+50+50>.
		1246	Alternatively, a predefined set of templates can be used to achieve
		1247	the most common setups:
		1248
		1249	=over 4
		1250
		1251	=item B<style=tiled>
		1252
		1253	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1254
		1255	=item B<style=aspect-stretched>
		1256
		1257	the image is scaled to fill the whole window maintaining the aspect
		1258	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1259
		1260	=item B<style=stretched>
		1261
		1262	the image is scaled to fill the whole window. Equivalent to 100x100
		1263
		1264	=item B<style=centered>
		1265
		1266	the image is centered with no scaling. Equivalent to 0x0+50+50
		1267
		1268	=item B<style=root-tiled>
		1269
		1270	the image is tiled with no scaling and using 'root' positioning.
		1271	Equivalent to 0x0:op=tile:op=root-align
		1272
		1273	=back
		1274
		1275	If multiple templates are specified the last one wins. Note that a
		1276	template overrides all the scale, position and operations settings.
		1277
		1278	If used in conjunction with pseudo-transparency, the specified pixmap
		1279	will be blended over the transparent background using alpha-blending.
		1280
		1281	=item B<-tr>\|B<+tr>
		1282
		1283	=item B<transparent:> I<boolean>
		1284
		1285	Turn on/off pseudo-transparency by using the root pixmap as background.
		1286
		1287	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1288	will be removed in future versions.
		1289
		1290	=item B<-tint> I<colour>
		1291
		1292	=item B<tintColor:> I<colour>
		1293
		1294	Tint the transparent background with the given colour. Note that a
		1295	black tint yields a completely black image while a white tint yields
		1296	the image unchanged.
		1297
		1298	=item B<-sh> I<number>
		1299
		1300	=item B<shading:> I<number>
		1301
		1302	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1303	A value of 100 means no shading.
		1304
		1305	=item B<-blr> I<HxV>
		1306
		1307	=item B<blurRadius:> I<HxV>
		1308
		1309	Apply gaussian blur with the specified radius to the transparent
		1310	background. If a single number is specified, the vertical and
		1311	horizontal radii are considered to be the same. Setting one of the
		1312	radii to 1 and the other to a large number creates interesting effects
		1313	on some backgrounds. The maximum radius value is 128. An horizontal or
		1314	vertical radius of 0 disables blurring.
		1315
		1316	=item B<path:> I<path>
		1317
		1318	Specify the colon-delimited search path for finding background image files.
1169		1319
1170	=back	1320	=back
1171		1321
1172	=head1 THE SCROLLBAR	1322	=head1 THE SCROLLBAR
1173		1323
…		…
1192	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1342	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1193	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1343	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1194	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1344	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1195	respectively.	1345	respectively.
1196		1346
1197	=head1 TEXT SELECTION AND INSERTION	1347	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1198		1348
1199	The behaviour of text selection and insertion mechanism is similar to	1349	The behaviour of text selection and insertion/pasting mechanism is similar
1200	I<xterm>(1).	1350	to I<xterm>(1).
1201		1351
1202	=over 4	1352	=over 4
1203		1353
1204	=item B<Selection>:	1354	=item B<Selecting>:
1205		1355
1206	Left click at the beginning of the region, drag to the end of the region	1356	Left click at the beginning of the region, drag to the end of the region
1207	and release; Right click to extend the marked region; Left double-click	1357	and release; Right click to extend the marked region; Left double-click
1208	to select a word; Left triple-click to select the entire logical line	1358	to select a word; Left triple-click to select the entire logical line
1209	(which can span multiple screen lines), unless modified by resource	1359	(which can span multiple screen lines), unless modified by resource
…		…
1213	(Compile: I<frills>) will create a rectangular selection instead of a	1363	(Compile: I<frills>) will create a rectangular selection instead of a
1214	normal one. In this mode, every selected row becomes its own line in the	1364	normal one. In this mode, every selected row becomes its own line in the
1215	selection, and trailing whitespace is visually underlined and removed from	1365	selection, and trailing whitespace is visually underlined and removed from
1216	the selection.	1366	the selection.
1217		1367
1218	=item B<Insertion>:	1368	=item B<Pasting>:
1219		1369
1220	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1370	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1221	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1371	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1222	Meta modifier) to be inserted as if it had been typed on the keyboard.	1372	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1223		1373
1224	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1374	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225	inserted too.	1375	inserted too.
1226		1376
1227	=back	1377	=back
…		…
1244		1394
1245	=head1 ISO 14755 SUPPORT	1395	=head1 ISO 14755 SUPPORT
1246		1396
1247	ISO 14755 is a standard for entering and viewing unicode characters	1397	ISO 14755 is a standard for entering and viewing unicode characters
1248	and character codes using the keyboard. It consists of 4 parts. The	1398	and character codes using the keyboard. It consists of 4 parts. The
1249	first part is available rxvt-unicode has been compiled with	1399	first part is available if rxvt-unicode has been compiled with
1250	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1400	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1251	with C<--enable-iso14755>.	1401	with C<--enable-iso14755>.
1252		1402
1253	=over 4	1403	=over 4
1254		1404
…		…
1312	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1462	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1313	it can be seen via the I<who(1)> command, and can accept messages. To	1463	it can be seen via the I<who(1)> command, and can accept messages. To
1314	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1464	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1315	on some systems or setgid to root or to some other group on others.	1465	on some systems or setgid to root or to some other group on others.
1316		1466
1317	=head1 COLORS AND GRAPHICS	1467	=head1 COLOURS AND GRAPHICS
1318		1468
1319	In addition to the default foreground and background colours,	1469	In addition to the default foreground and background colours,
1320	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1470	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1321	high-intensity bold/blink versions of the same). Here is a list of the	1471	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1322	colours with their names.	1472	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1473	cube plus a 8 (24) colour greyscale ramp.
		1474
		1475	Here is a list of the ANSI colours with their names.
1323		1476
1324	=begin table	1477	=begin table
1325		1478
1326	B<color0> (black) = Black	1479	B<color0> (black) = Black
1327	B<color1> (red) = Red3	1480	B<color1> (red) = Red3
…		…
1347	It is also possible to specify the colour values of B<foreground>,	1500	It is also possible to specify the colour values of B<foreground>,
1348	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1501	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1349	a number 0-15, as a convenient shorthand to reference the colour name of	1502	a number 0-15, as a convenient shorthand to reference the colour name of
1350	color0-color15.	1503	color0-color15.
1351		1504
1352	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1505	The following text gives values for the standard 88 colour mode (and
1353	additional 72 colours. The first 64 of those (with indices 16 to 79)	1506	values for the 256 colour mode in parentheses).
1354	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1355	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1356		1507
		1508	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1509
		1510	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1511	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1512
		1513	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1514	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1515	the RGB cube.
		1516
1357	Together, all those colours implement the 88 colour xterm colours. Only	1517	Together, all those colours implement the 88 (256) colour xterm
1358	the first 16 can be changed using resources currently, the rest can only	1518	colours. Only the first 16 can be changed using resources currently, the
1359	be changed via command sequences ("escape codes").	1519	rest can only be changed via command sequences ("escape codes").
		1520
		1521	Applications are advised to use terminfo or command sequences to discover
		1522	number and RGB values of all colours (yes, you can query this...).
1360		1523
1361	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1524	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1362	always swapping the foreground/background colours. This is in contrast to	1525	always swapping the foreground/background colours. This is in contrast to
1363	I<xterm>(1) where the colours are only swapped if they have not otherwise	1526	I<xterm>(1) where the colours are only swapped if they have not otherwise
1364	been specified. For example,	1527	been specified. For example,
1365		1528
1366	=over 4
1367
1368	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1529	@@RXVT_NAME@@ -fg Black -bg White -rv
1369		1530
1370	would yield White on Black, while on I<xterm>(1) it would yield Black	1531	would yield White on Black, while on I<xterm>(1) it would yield Black on
1371	on White.	1532	White.
1372
1373	=back
1374		1533
1375	=head2 ALPHA CHANNEL SUPPORT	1534	=head2 ALPHA CHANNEL SUPPORT
1376		1535
1377	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1536	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1378	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1537	their act together, rxvt-unicode will do its own alpha channel management:
1379	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1538
1380	in addition to the ones provided by X, where the additional A component	1539	You can prefix any colour with an opaqueness percentage enclosed in
		1540	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1541	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1542	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1543	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1544	is the recommended format to specify transparency values, and works with
		1545	all ways to specify a colour.
		1546
		1547	For complete control, rxvt-unicode also supports
		1548	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1549	specifications, where the additional C<aaaa> component specifies opacity
1381	specifies opacity (alpha) values. The minimum value of C<0> is completely	1550	(alpha) values. The minimum value of C<0000> is completely transparent,
1382	transparent). You can also prefix any color with C<[a]>, where C<a> is on	1551	while C<ffff> is completely opaque). The two example colours from
1383	to four hex digits specifiying the opacity value.	1552	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1553	C<rgba:0000/ff00/0000/f332>.
1384		1554
1385	You probably need to specify B<"-depth 32">, too, and have the luck that	1555	You probably need to specify B<"-depth 32">, too, to force a visual with
1386	your X-server uses ARGB pixel layout, as X is far from just supporting	1556	alpha channels, and have the luck that your X-server uses ARGB pixel
1387	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1557	layout, as X is far from just supporting ARGB visuals out of the box, and
		1558	rxvt-unicode just fudges around.
1388		1559
1389	For example, the following selects an almost completely transparent red	1560	For example, the following selects an almost completely transparent black
1390	background, and an almost opaque pink foreground:	1561	background, and an almost opaque pink foreground:
1391		1562
1392	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"	1563	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1393		1564
1394	I<Please note that transparency of any kind if completely unsupported by	1565	When not using a background image, then the interpretation of the
1395	the author. Don't bug him with installation questions!>	1566	alpha channel is up to your compositing manager (most interpret it as
		1567	transparency of course).
		1568
		1569	When using a background pixmap or pseudo-transparency, then the background
		1570	colour will always behave as if it were completely transparent (so the
		1571	background image shows instead), regardless of how it was specified, while
		1572	other colours will either be transparent as specified (the background
		1573	image will show through) on servers supporting the RENDER extension, or
		1574	fully opaque on servers not supporting the RENDER EXTENSION.
		1575
		1576	Please note that due to bugs in Xft, specifying alpha values might result
		1577	in garbage being displayed when the X-server does not support the RENDER
		1578	extension.
1396		1579
1397	=head1 ENVIRONMENT	1580	=head1 ENVIRONMENT
1398		1581
1399	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1582	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1400		1583
…		…
1406	resources or on the command line.	1589	resources or on the command line.
1407		1590
1408	=item B<COLORTERM>	1591	=item B<COLORTERM>
1409		1592
1410	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1593	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1411	compiled with XPM support, and optionally with the added extension	1594	compiled with background image support, and optionally with the added
1412	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1595	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1596	screen.
1413		1597
1414	=item B<COLORFGBG>	1598	=item B<COLORFGBG>
1415		1599
1416	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1600	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1417	the colour code used as default foreground/text colour (or the string	1601	the colour code used as default foreground/text colour (or the string
1418	C<default> to indicate that the default-colour escape sequence is to be	1602	C<default> to indicate that the default-colour escape sequence is to be
1419	used), C<bg> is the colour code used as default background colour (or the	1603	used), C<bg> is the colour code used as default background colour (or the
1420	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1604	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1421	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1605	was compiled with background image support. Libraries like C<ncurses>
1422	(and do) use this information to optimize screen output.	1606	and C<slang> can (and do) use this information to optimize screen output.
1423		1607
1424	=item B<WINDOWID>	1608	=item B<WINDOWID>
1425		1609
1426	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1610	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1427	window, which usually has subwindows for the scrollbar, the terminal	1611	window, which usually has subwindows for the scrollbar, the terminal
…		…
1433	C<--with-terminfo=PATH>.	1617	C<--with-terminfo=PATH>.
1434		1618
1435	=item B<DISPLAY>	1619	=item B<DISPLAY>
1436		1620
1437	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1621	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1438	display in its child processes.	1622	display in its child processes if C<-display> isn't used to override. It
		1623	defaults to C<:0> if it doesn't exist.
1439		1624
1440	=item B<SHELL>	1625	=item B<SHELL>
1441		1626
1442	The shell to be used for command execution, defaults to C</bin/sh>.	1627	The shell to be used for command execution, defaults to C</bin/sh>.
1443		1628
1444	=item B<RXVT_SOCKET>	1629	=item B<RXVT_SOCKET> [I<sic>]
1445		1630
1446	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1631	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1447	@@RXVT_NAME@@d(1).	1632	@@RXVT_NAME@@d(1).
1448		1633
1449	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1634	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1635
		1636	=item B<URXVT_PERL_LIB>
		1637
		1638	Additional F<:>-separated library search path for perl extensions. Will be
		1639	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1640	directory.
		1641
		1642	=item B<URXVT_PERL_VERBOSITY>
		1643
		1644	See L<@@RXVT_NAME@@perl>(3).
1450		1645
1451	=item B<HOME>	1646	=item B<HOME>
1452		1647
1453	Used to locate the default directory for the unix domain socket for	1648	Used to locate the default directory for the unix domain socket for
1454	daemon communications and to locate various resource files (such as	1649	daemon communications and to locate various resource files (such as
1455	C<.Xdefaults>)	1650	C<.Xdefaults>)
1456		1651
1457	=item B<XAPPLRESDIR>	1652	=item B<XAPPLRESDIR>
1458		1653
1459	Directory where various X resource files are being located.	1654	Directory where application-specific X resource files are located.
1460		1655
1461	=item B<XENVIRONMENT>	1656	=item B<XENVIRONMENT>
1462		1657
1463	If set and accessible, gives the name of a X resource file to be loaded by	1658	If set and accessible, gives the name of a X resource file to be loaded by
1464	@@RXVT_NAME@@.	1659	@@RXVT_NAME@@.
…		…
1469		1664
1470	=over 4	1665	=over 4
1471		1666
1472	=item B</usr/lib/X11/rgb.txt>	1667	=item B</usr/lib/X11/rgb.txt>
1473		1668
1474	Color names.	1669	Colour names.
1475		1670
1476	=back	1671	=back
1477		1672
1478	=head1 SEE ALSO	1673	=head1 SEE ALSO
1479		1674
		1675	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1480	@@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)	1676	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1481		1677
1482	=head1 CURRENT PROJECT COORDINATOR	1678	=head1 CURRENT PROJECT COORDINATOR
1483		1679
1484	=over 4	1680	=over 4
1485		1681
…		…
1518	Project Coordinator (changes.txt 2.21a to 2.4.5)	1714	Project Coordinator (changes.txt 2.21a to 2.4.5)
1519		1715
1520	=item Geoff Wing L<< <gcw@pobox.com> >>	1716	=item Geoff Wing L<< <gcw@pobox.com> >>
1521		1717
1522	Rewrote screen display and text selection routines.	1718	Rewrote screen display and text selection routines.
1523		1719
1524	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1720	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1525		1721
1526	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1722	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1527		1723
1528	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1724	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1530		1726
1531	Project Coordinator (Changes 1.0 -)	1727	Project Coordinator (Changes 1.0 -)
1532		1728
1533	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1729	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1534		1730
1535	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1731	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1536		1732
1537	=back	1733	=back
1538		1734

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC vs. Revision 1.221 by sf-exg, Mon Nov 5 12:59:13 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC vs.
Revision 1.221 by sf-exg, Mon Nov 5 12:59:13 2012 UTC