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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 UTC vs.
Revision 1.215 by sf-exg, Sun May 20 16:34:42 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/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<xft>: 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
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
107	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
108		116
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		118
111	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
112		120
113	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		122
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		126
120	I<Please note that transparency of any kind if completely unsupported by	127	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions! Read the FAQ (man 7	128
122	@@RXVT_NAME@@)!>	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
123		133
124	=item B<-fade> I<number>	134	=item B<-fade> I<number>
125		135
126	Fade the text by the given percentage when focus is lost. Small values	136	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	137	fade a little only, 100 completely replaces all colours by the fade
…		…
132	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
133	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
134		144
135	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
136		146
137	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
138	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	resource I<tintColor>.
139	non-tiled backgrounds, currently. See also the B<-sh> option that can be
140	used to brighten or darken the image in addition to tinting it; resource
141	I<tintColor>. Example:
142		149
143	@@RXVT_NAME@@ -tr -tint blue -sh 40
144
145	=item B<-sh> I<number>	150	=item B<-sh> I<number>
146		151
147	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
148	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
149	resource I<shading>.
150		154
151	=item B<-blt> I<string>
152
153	Specify background blending type. If background pixmap is specified
154	at the same time as transparency - such pixmap will be blended over
155	transparency image, using method specified. Supported values are :
156	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
157	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
158	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
159	alpha-blending; resource I<blendType>.
160
161	=item B<-blr> I<number>	155	=item B<-blr> I<HxV>
162		156
163	Apply Gaussian Blur with the specified radius to the transparent	157	Apply Gaussian Blur with the specified radii to the transparent
164	background image; resource I<blurRadius>.	158	background. If a single number is specified, the vertical and
		159	horizontal radii are considered to be the same. Setting one of the
		160	radii to 1 and the other to a large number creates interesting effects
		161	on some backgrounds. The maximum radius value is 128. An horizontal or
		162	vertical radius of 0 disables blurring;
		163	resource I<blurRadius>.
		164
		165	=item B<-icon> I<file>
		166
		167	Compile I<pixbuf>: Use the specified image as application icon. This
		168	is used by many window managers, taskbars and pagers to represent the
		169	application window; resource I<iconFile>.
165		170
166	=item B<-bg> I<colour>	171	=item B<-bg> I<colour>
167		172
168	Window background colour; resource B<background>.	173	Window background colour; resource B<background>.
169		174
170	=item B<-fg> I<colour>	175	=item B<-fg> I<colour>
171		176
172	Window foreground colour; resource B<foreground>.	177	Window foreground colour; resource B<foreground>.
173		178
174	=item B<-pixmap> I<file[;geom]>	179	=item B<-pixmap> I<file[;oplist]>
175		180
176	Compile I<afterimage>: Specify image file for the background and also	181	Compile I<pixbuf>: Specify image file for the background and also
177	optionally specify its scaling with a geometry string. Note you may need to	182	optionally specify a list of operations to modify it. Note you may need to
178	add quotes to avoid special shell interpretation of the C<;> in the	183	add quotes to avoid special shell interpretation of the C<;> in the
179	command-line; for more details see resource B<backgroundPixmap>.	184	command-line; for more details see resource B<backgroundPixmap>.
180		185
181	=item B<-cr> I<colour>	186	=item B<-cr> I<colour>
182		187
…		…
229	italic> >> characters are to be printed. See resource B<boldItalicFont>	234	italic> >> characters are to be printed. See resource B<boldItalicFont>
230	for details.	235	for details.
231		236
232	=item B<-is>\|B<+is>	237	=item B<-is>\|B<+is>
233		238
234	Compile I<font-styles>: Bold/Italic font styles imply high intensity	239	Compile I<font-styles>: Bold/Blink font styles imply high intensity
235	foreground/background (default). See resource B<intensityStyles> for	240	foreground/background (default). See resource B<intensityStyles> for
236	details.	241	details.
237		242
238	=item B<-name> I<name>	243	=item B<-name> I<name>
239		244
…		…
257		262
258	=item B<-sb>\|B<+sb>	263	=item B<-sb>\|B<+sb>
259		264
260	Turn on/off scrollbar; resource B<scrollBar>.	265	Turn on/off scrollbar; resource B<scrollBar>.
261		266
		267	=item B<-sr>\|B<+sr>
		268
		269	Put scrollbar on right/left; resource B<scrollBar_right>.
		270
		271	=item B<-st>\|B<+st>
		272
		273	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		274	resource B<scrollBar_floating>.
		275
262	=item B<-si>\|B<+si>	276	=item B<-si>\|B<+si>
263		277
264	Turn on/off scroll-to-bottom on TTY output inhibit; resource	278	Turn on/off scroll-to-bottom on TTY output inhibit; resource
265	B<scrollTtyOutput> has opposite effect.	279	B<scrollTtyOutput> has opposite effect.
266		280
…		…
272	=item B<-sw>\|B<+sw>	286	=item B<-sw>\|B<+sw>
273		287
274	Turn on/off scrolling with the scrollback buffer as new lines appear.	288	Turn on/off scrolling with the scrollback buffer as new lines appear.
275	This only takes effect if B<-si> is also given; resource	289	This only takes effect if B<-si> is also given; resource
276	B<scrollWithBuffer>.	290	B<scrollWithBuffer>.
277
278	=item B<-sr>\|B<+sr>
279
280	Put scrollbar on right/left; resource B<scrollBar_right>.
281
282	=item B<-st>\|B<+st>
283
284	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
285	resource B<scrollBar_floating>.
286		291
287	=item B<-ptab>\|B<+ptab>	292	=item B<-ptab>\|B<+ptab>
288		293
289	If enabled (default), "Horizontal Tab" characters are being stored as	294	If enabled (default), "Horizontal Tab" characters are being stored as
290	actual wide characters in the screen buffer, which makes it possible to	295	actual wide characters in the screen buffer, which makes it possible to
…		…
294		299
295	=item B<-bc>\|B<+bc>	300	=item B<-bc>\|B<+bc>
296		301
297	Blink the cursor; resource B<cursorBlink>.	302	Blink the cursor; resource B<cursorBlink>.
298		303
		304	=item B<-uc>\|B<+uc>
		305
		306	Make the cursor underlined; resource B<cursorUnderline>.
		307
299	=item B<-iconic>	308	=item B<-iconic>
300		309
301	Start iconified, if the window manager supports that option.	310	Start iconified, if the window manager supports that option.
302	Alternative form is B<-ic>.	311	Alternative form is B<-ic>.
303		312
…		…
319		328
320	=item B<-bl>	329	=item B<-bl>
321		330
322	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	331	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
323	if honoured by the WM, the rxvt-unicode window will not have window	332	if honoured by the WM, the rxvt-unicode window will not have window
324	decorations; resource B<borderLess>.	333	decorations; resource B<borderLess>. If the window manager does not
		334	support MWM hints (e.g. kwin), enables override-redirect mode.
325		335
326	=item B<-override-redirect>	336	=item B<-override-redirect>
327		337
328	Compile I<frills>: Sets override-redirect on the window; resource	338	Compile I<frills>: Sets override-redirect on the window; resource
329	B<override-redirect>.	339	B<override-redirect>.
…		…
337		347
338	=item B<-lsp> I<number>	348	=item B<-lsp> I<number>
339		349
340	Compile I<frills>: Lines (pixel height) to insert between each row of	350	Compile I<frills>: Lines (pixel height) to insert between each row of
341	the display. Useful to work around font rendering problems; resource	351	the display. Useful to work around font rendering problems; resource
342	B<linespace>.	352	B<lineSpace>.
		353
		354	=item B<-letsp> I<number>
		355
		356	Compile I<frills>: Amount to adjust the computed character width by
		357	to control overall letter spacing. Negative values will tighten up the
		358	letter spacing, positive values will space letters out more. Useful to
		359	work around odd font metrics; resource B<letterSpace>.
343		360
344	=item B<-tn> I<termname>	361	=item B<-tn> I<termname>
345		362
346	This option specifies the name of the terminal type to be set in the	363	This option specifies the name of the terminal type to be set in the
347	B<TERM> environment variable. This terminal type must exist in the	364	B<TERM> environment variable. This terminal type must exist in the
…		…
402		419
403	=item B<-tcw>	420	=item B<-tcw>
404		421
405	Change the meaning of triple-click selection with the left mouse	422	Change the meaning of triple-click selection with the left mouse
406	button. Only effective when the original (non-perl) selection code is	423	button. Only effective when the original (non-perl) selection code is
407	in-use. Instead of selecting a full line it will extend the selection the	424	in-use. Instead of selecting a full line it will extend the selection to
408	end of the logical line only. resource B<tripleclickwords>.	425	the end of the logical line only. resource B<tripleclickwords>.
409		426
410	=item B<-insecure>	427	=item B<-insecure>
411		428
412	Enable "insecure" mode, which currently enables most of the escape	429	Enable "insecure" mode, which currently enables most of the escape
413	sequences that echo strings. See the resource B<insecure> for more	430	sequences that echo strings. See the resource B<insecure> for more
…		…
433		450
434	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	451	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
435	will not immediately destroy its window when the program executed within	452	will not immediately destroy its window when the program executed within
436	it exits. Instead, it will wait till it is being killed or closed by the	453	it exits. Instead, it will wait till it is being killed or closed by the
437	user; resource B<hold>.	454	user; resource B<hold>.
		455
		456	=item B<-cd> I<path>
		457
		458	Sets the working directory for the shell (or the command specified via
		459	B<-e>). The I<path> must be an absolute path and it must exist for
		460	@@RXVT_NAME@@ to start; resource B<chdir>.
		461
		462	=item B<-xrm> I<string>
		463
		464	Works like the X Toolkit option of the same name, by adding the I<string>
		465	as if it were specified in a resource file. Resource values specified this
		466	way take precedence over all other resource specifications.
		467
		468	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		469	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		470	options can be specified as long-options on the commandline, so use
		471	of B<-xrm> is mostly limited to cases where you want to specify other
		472	resources (e.g. for input methods) or for compatibility with other
		473	programs.
438		474
439	=item B<-keysym.>I<sym> I<string>	475	=item B<-keysym.>I<sym> I<string>
440		476
441	Remap a key symbol. See resource B<keysym>.	477	Remap a key symbol. See resource B<keysym>.
442		478
…		…
477	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	513	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
478	entries and will not tinker with pty/tty permissions - you have to do that	514	entries and will not tinker with pty/tty permissions - you have to do that
479	yourself if you want that.	515	yourself if you want that.
480		516
481	As an extremely special case, specifying C<-1> will completely suppress	517	As an extremely special case, specifying C<-1> will completely suppress
482	pty/tty operations.	518	pty/tty operations, which is probably only useful in conjunction with some
		519	perl extension that manages the terminal.
483		520
484	Here is a example in perl that illustrates how this option can be used (a	521	Here is a example in perl that illustrates how this option can be used (a
485	longer example is in F<doc/pty-fd>):	522	longer example is in F<doc/pty-fd>):
486		523
487	use IO::Pty;	524	use IO::Pty;
…		…
501	Comma-separated list of perl extension scripts to use (or not to use) in	538	Comma-separated list of perl extension scripts to use (or not to use) in
502	this terminal instance. See resource B<perl-ext> for details.	539	this terminal instance. See resource B<perl-ext> for details.
503		540
504	=back	541	=back
505		542
506	=head1 RESOURCES (available also as long-options)	543	=head1 RESOURCES
507		544
508	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	545	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
509	options) compiled into your version.	546	options) compiled into your version. All resources are also available as
		547	long-options.
510		548
511	You can set and change the resources using X11 tools like B<xrdb>. Many	549	You can set and change the resources using X11 tools like B<xrdb>. Many
512	distribution do also load settings from the B<~/.Xresources> file when X	550	distribution do also load settings from the B<~/.Xresources> file when X
513	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	551	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
514	with later settings overwriting earlier ones:	552	with later settings overwriting earlier ones:
515		553
516	1. system-wide app-defaults file, either locale-dependent OR global
517	2. app-defaults file in $XAPPLRESDIR	554	1. app-defaults file in $XAPPLRESDIR
		555	2. $HOME/.Xdefaults
518	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	556	3. RESOURCE_MANAGER property on root-window of screen 0
519	4. SCREEN_RESOURCES for the current screen	557	4. SCREEN_RESOURCES property on root-window of the current screen
520	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	558	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		559	6. resources specified via -xrm on the commandline
521		560
522	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	561	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
523	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	562	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
524	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	563	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
525	configured, while the class name B<URxvt> allows resources unique to	564	configured, while the class name B<URxvt> allows resources unique to
…		…
535	=item B<depth:> I<bitdepth>	574	=item B<depth:> I<bitdepth>
536		575
537	Compile I<xft>: Attempt to find a visual with the given bit depth;	576	Compile I<xft>: Attempt to find a visual with the given bit depth;
538	option B<-depth>.	577	option B<-depth>.
539		578
		579	=item B<buffered:> I<boolean>
		580
		581	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		582	On some card/driver combination enabling it slightly decreases
		583	performance, on most it greatly helps it. The slowdown is small, so it
		584	should normally be enabled.
		585
540	=item B<geometry:> I<geom>	586	=item B<geometry:> I<geom>
541		587
542	Create the window with the specified X window geometry [default 80x24];	588	Create the window with the specified X window geometry [default 80x24];
543	option B<-geometry>.	589	option B<-geometry>.
544		590
…		…
557	Use the specified colour for the colour value I<n>, where 0-7	603	Use the specified colour for the colour value I<n>, where 0-7
558	corresponds to low-intensity (normal) colours and 8-15 corresponds to	604	corresponds to low-intensity (normal) colours and 8-15 corresponds to
559	high-intensity (bold = bright foreground, blink = bright background)	605	high-intensity (bold = bright foreground, blink = bright background)
560	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	606	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
561	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	607	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
562	names used are listed in the B<COLORS AND GRAPHICS> section.	608	names used are listed in the B<COLOURS AND GRAPHICS> section.
563		609
564	Colours higher than 15 cannot be set using resources (yet), but can be	610	Colours higher than 15 cannot be set using resources (yet), but can be
565	changed using an escape command (see @@RXVT_NAME@@(7)).	611	changed using an escape command (see @@RXVT_NAME@@(7)).
566		612
567	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	613	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
578	=item B<colorUL:> I<colour>	624	=item B<colorUL:> I<colour>
579		625
580	Use the specified colour to display underlined characters when the	626	Use the specified colour to display underlined characters when the
581	foreground colour is the default.	627	foreground colour is the default.
582		628
583	=item B<colorRV:> I<colour>
584
585	Use the specified colour as the background for reverse video characters
586	when OPTION_HC is disabled (--disable-frills).
587
588	=item B<underlineColor:> I<colour>	629	=item B<underlineColor:> I<colour>
589		630
590	If set, use the specified colour as the colour for the underline	631	If set, use the specified colour as the colour for the underline
591	itself. If unset, use the foreground colour.	632	itself. If unset, use the foreground colour.
		633
		634	=item B<highlightColor:> I<colour>
		635
		636	If set, use the specified colour as the background for highlighted
		637	characters. If unset, use reverse video.
		638
		639	=item B<highlightTextColor:> I<colour>
		640
		641	If set and highlightColor is set, use the specified colour as the
		642	foreground for highlighted characters.
592		643
593	=item B<cursorColor:> I<colour>	644	=item B<cursorColor:> I<colour>
594		645
595	Use the specified colour for the cursor. The default is to use the	646	Use the specified colour for the cursor. The default is to use the
596	foreground colour; option B<-cr>.	647	foreground colour; option B<-cr>.
…		…
603		654
604	=item B<reverseVideo:> I<boolean>	655	=item B<reverseVideo:> I<boolean>
605		656
606	B<True>: simulate reverse video by foreground and background colours;	657	B<True>: simulate reverse video by foreground and background colours;
607	option B<-rv>. B<False>: regular screen colours [default]; option	658	option B<-rv>. B<False>: regular screen colours [default]; option
608	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	659	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
609		660
610	=item B<jumpScroll:> I<boolean>	661	=item B<jumpScroll:> I<boolean>
611		662
612	B<True>: specify that jump scrolling should be used. When scrolling	663	B<True>: specify that jump scrolling should be used. When receiving lots
613	quickly, fewer screen updates are performed [default]; option B<-j>.	664	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		665	has been read, resulting in fewer updates while still displaying every
		666	received line; option B<-j>.
		667
614	B<False>: specify that smooth scrolling should be used; option B<+j>.	668	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		669	force a screen refresh on each new line it received; option B<+j>.
615		670
616	=item B<inheritPixmap:> I<boolean>	671	=item B<skipScroll:> I<boolean>
617		672
618	B<True>: make the background inherit the parent windows' pixmap, giving	673	B<True>: (the default) specify that skip scrolling should be used. When
619	artificial transparency. B<False>: do not inherit the parent windows'	674	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
620	pixmap.	675	(around 60 times per second), resulting in far fewer updates. This can
		676	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		677	option B<-ss>.
621		678
622	I<Please note that transparency of any kind if completely unsupported by	679	B<False>: specify that everything is to be displayed, even
623	the author. Don't bug him with installation questions!>	680	if the refresh is too fast for the human eye to read anything (or the
		681	monitor to display anything); option B<+ss>.
		682
		683	=item B<transparent:> I<boolean>
		684
		685	Turn on/off pseudo-transparency by using the root pixmap as background.
		686
		687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		688	future versions.
624		689
625	=item B<fading:> I<number>	690	=item B<fading:> I<number>
626		691
627	Fade the text by the given percentage when focus is lost; option B<-fade>.	692	Fade the text by the given percentage when focus is lost; option B<-fade>.
628		693
…		…
631	Fade to this colour, when fading is used (see B<fading:>). The default	696	Fade to this colour, when fading is used (see B<fading:>). The default
632	colour is black; option B<-fadecolor>.	697	colour is black; option B<-fadecolor>.
633		698
634	=item B<tintColor:> I<colour>	699	=item B<tintColor:> I<colour>
635		700
636	Tint the transparent background pixmap with the given colour; option	701	Tint the transparent background with the given colour. If the RENDER
637	B<-tint>.	702	extension is not available only black, red, green, yellow, blue,
		703	magenta, cyan and white tints can be performed server-side. Note that
		704	a black tint yields a completely black image while a white tint yields
		705	the image unchanged; option B<-tint>.
638		706
639	=item B<shading:> I<number>	707	=item B<shading:> I<number>
640		708
641	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
642	in addition to tinting it; option B<-sh>.	710	A value of 100 means no shading; option B<-sh>.
643
644	=item B<blendType:> I<string>
645
646	Specify background blending type; option B<-blt>.
647		711
648	=item B<blurRadius:> I<number>	712	=item B<blurRadius:> I<number>
649		713
650	Apply Gaussian Blurr with the specified radius to the transparent	714	Apply gaussian blur with the specified radius to the transparent
651	background image; option B<-blr>.	715	background; option B<-blr>.
		716
		717	=item B<iconFile:> I<file>
		718
		719	Set the application icon pixmap; option B<-icon>.
652		720
653	=item B<scrollColor:> I<colour>	721	=item B<scrollColor:> I<colour>
654		722
655	Use the specified colour for the scrollbar [default #B2B2B2].	723	Use the specified colour for the scrollbar [default #B2B2B2].
656		724
…		…
662	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
663		731
664	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
665	and the text.	733	and the text.
666		734
667	=item B<backgroundPixmap:> I<file[;geom]>	735	=item B<backgroundPixmap:> I<file[;oplist]>
668		736
669	Use the specified image file for the background and also optionally	737	Use the specified image file for the background and also
670	specify its scaling with a geometry string B<WxH+X+Y>,	738	optionally specify a colon separated list of operations to modify it.
671	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	739	Supported operations are:
		740
		741	=over 4
		742
		743	=item B<WxH+X+Y>
		744
		745	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
672	and B<"X" / "Y"> locate the image centre (percent).	746	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
673	A scale of 0 displays the image with tiling. A scale of 1 displays the	747	scale of 0 disables scaling.
674	image without any scaling. A scale of 2 to 9 specifies an integer	748
675	number of images in that direction. No image will be magnified beyond	749	=item B<op=tile>
676	10 times its original size. The maximum permitted scale is 1000.	750
677	Special string of B<"auto"> used as a geometry will cause image to be	751	enables tiling
678	automatically scaled to match window size.	752
		753	=item B<op=keep-aspect>
		754
		755	maintain the image aspect ratio when scaling
		756
		757	=item B<op=root-align>
		758
		759	use the position of the terminal window relative to the root window as
		760	the image offset, simulating a root window background
		761
		762	=back
		763
		764	The default scale and position setting is C<100x100+50+50>.
		765	Alternatively, a predefined set of templates can be used to achieve
		766	the most common setups:
		767
		768	=over 4
		769
		770	=item B<style=tiled>
		771
		772	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		773
		774	=item B<style=aspect-stretched>
		775
		776	the image is scaled to fill the whole window maintaining the aspect
		777	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		778
		779	=item B<style=stretched>
		780
		781	the image is scaled to fill the whole window. Equivalent to 100x100
		782
		783	=item B<style=centered>
		784
		785	the image is centered with no scaling. Equivalent to 0x0+50+50
		786
		787	=item B<style=root-tiled>
		788
		789	the image is tiled with no scaling and using 'root' positioning.
		790	Equivalent to 0x0:op=tile:op=root-align
		791
		792	=back
		793
		794	If multiple templates are specified the last one wins. Note that a
		795	template overrides all the scale, position and operations settings.
		796
679	If used in conjunction with B<-tr> option - specified pixmap will be	797	If used in conjunction with B<-tr> option, the specified pixmap will be
680	blended over transparency image using either alpha-blending, or any	798	blended over the transparent background using alpha-blending.
681	other blending type, specified with B<-blt "type"> option.
682	[default 0x0+50+50]
683		799
684	=item B<path:> I<path>	800	=item B<path:> I<path>
685		801
686	Specify the colon-delimited search path for finding XPM files.	802	Specify the colon-delimited search path for finding background image files.
687		803
688	=item B<font:> I<fontlist>	804	=item B<font:> I<fontlist>
689		805
690	Select the fonts to be used. This is a comma separated list of font names	806	Select the fonts to be used. This is a comma separated list of font names
691	that are checked in order when trying to find glyphs for characters. The	807	that are checked in order when trying to find glyphs for characters. The
…		…
714	it is named first) and thus defines the character cell grid to be 9 pixels	830	it is named first) and thus defines the character cell grid to be 9 pixels
715	wide and 15 pixels high.	831	wide and 15 pixels high.
716		832
717	The second font is just used to add additional unicode characters not in	833	The second font is just used to add additional unicode characters not in
718	the base font, likewise the third, which is unfortunately non-bold, but	834	the base font, likewise the third, which is unfortunately non-bold, but
719	the bold version of the font does contain less characters, so this is a	835	the bold version of the font does contain fewer characters, so this is a
720	useful supplement.	836	useful supplement.
721		837
722	The third font is an Xft font with aliasing turned off, and the characters	838	The third font is an Xft font with aliasing turned off, and the characters
723	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	839	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
724	contains other characters, but we are not interested in them.	840	contains other characters, but we are not interested in them.
…		…
748	text font will being used for the given style.	864	text font will being used for the given style.
749		865
750	=item B<intensityStyles:> I<boolean>	866	=item B<intensityStyles:> I<boolean>
751		867
752	When font styles are not enabled, or this option is enabled (B<True>,	868	When font styles are not enabled, or this option is enabled (B<True>,
753	option B<-is>, the default), bold and italic font styles imply high	869	option B<-is>, the default), bold/blink font styles imply high
754	intensity foreground/background colours. Disabling this option (B<False>,	870	intensity foreground/background colours. Disabling this option (B<False>,
755	option B<+is>) disables this behaviour, the high intensity colours are not	871	option B<+is>) disables this behaviour, the high intensity colours are not
756	reachable.	872	reachable.
757		873
758	=item B<selectstyle:> I<mode>
759
760	Set mouse selection style to B<old> which is 2.20, B<oldword> which
761	is xterm style with 2.20 old word selection, or anything else which
762	gives xterm style selection. Only effective when the original (non-perl)
763	selection code is in use.
764
765	=item B<scrollstyle:> I<mode>
766
767	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
768	the author's favourite.
769
770	=item B<title:> I<string>	874	=item B<title:> I<string>
771		875
772	Set window title string, the default title is the command-line	876	Set window title string, the default title is the command-line
773	specified after the B<-e> option, if any, otherwise the application	877	specified after the B<-e> option, if any, otherwise the application
774	name; option B<-title>.	878	name; option B<-title>.
…		…
787	=item B<urgentOnBell:> I<boolean>	891	=item B<urgentOnBell:> I<boolean>
788		892
789	B<True>: set the urgency hint for the wm on receipt of a bell character.	893	B<True>: set the urgency hint for the wm on receipt of a bell character.
790	B<False>: do not set the urgency hint [default].	894	B<False>: do not set the urgency hint [default].
791		895
		896	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		897
792	=item B<visualBell:> I<boolean>	898	=item B<visualBell:> I<boolean>
793		899
794	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	900	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
795	B<False>: no visual bell [default]; option B<+vb>.	901	B<False>: no visual bell [default]; option B<+vb>.
796		902
…		…
819	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	925	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
820		926
821	This creates a new file in your home directory with the screen contents	927	This creates a new file in your home directory with the screen contents
822	every time you hit C<Print>.	928	every time you hit C<Print>.
823		929
		930	=item B<scrollstyle:> I<mode>
		931
		932	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		933	the author's favourite.
		934
		935	=item B<thickness:> I<number>
		936
		937	Set the scrollbar width in pixels.
		938
824	=item B<scrollBar:> I<boolean>	939	=item B<scrollBar:> I<boolean>
825		940
826	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	941	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
827	disable the scrollbar; option B<+sb>.	942	disable the scrollbar; option B<+sb>.
828		943
…		…
847	B<False>: do not scroll to bottom when tty receives output; option	962	B<False>: do not scroll to bottom when tty receives output; option
848	B<+si>.	963	B<+si>.
849		964
850	=item B<scrollWithBuffer:> I<boolean>	965	=item B<scrollWithBuffer:> I<boolean>
851		966
852	B<True>: scroll with scrollback buffer when tty receives new lines (and	967	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
853	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	968	try to show the same lines) and B<scrollTtyOutput> is False; option
854	with scrollback buffer when tty receives new lines; option B<+sw>.	969	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		970	new lines; option B<+sw>.
855		971
856	=item B<scrollTtyKeypress:> I<boolean>	972	=item B<scrollTtyKeypress:> I<boolean>
857		973
858	B<True>: scroll to bottom when a non-special key is pressed. Special keys	974	B<True>: scroll to bottom when a non-special key is pressed. Special keys
859	are those which are intercepted by rxvt-unicode for special handling and	975	are those which are intercepted by rxvt-unicode for special handling and
…		…
890	=item B<termName:> I<termname>	1006	=item B<termName:> I<termname>
891		1007
892	Specifies the terminal type name to be set in the B<TERM> environment	1008	Specifies the terminal type name to be set in the B<TERM> environment
893	variable; option B<-tn>.	1009	variable; option B<-tn>.
894		1010
895	=item B<linespace:> I<number>	1011	=item B<lineSpace:> I<number>
896		1012
897	Specifies number of lines (pixel height) to insert between each row of	1013	Specifies number of lines (pixel height) to insert between each row of
898	the display [default 0]; option B<-lsp>.	1014	the display [default 0]; option B<-lsp>.
899		1015
900	=item B<meta8:> I<boolean>	1016	=item B<meta8:> I<boolean>
…		…
914		1030
915	=item B<cursorBlink:> I<boolean>	1031	=item B<cursorBlink:> I<boolean>
916		1032
917	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1033	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
918	option B<-bc>.	1034	option B<-bc>.
		1035
		1036	=item B<cursorUnderline:> I<boolean>
		1037
		1038	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1039	option B<-uc>.
919		1040
920	=item B<pointerBlank:> I<boolean>	1041	=item B<pointerBlank:> I<boolean>
921		1042
922	B<True>: blank the pointer when a key is pressed or after a set number	1043	B<True>: blank the pointer when a key is pressed or after a set number
923	of seconds of inactivity. B<False>: the pointer is always visible	1044	of seconds of inactivity. B<False>: the pointer is always visible
…		…
937	large number (e.g. C<987654321>) to effectively disable the timeout.	1058	large number (e.g. C<987654321>) to effectively disable the timeout.
938		1059
939	=item B<backspacekey:> I<string>	1060	=item B<backspacekey:> I<string>
940		1061
941	The string to send when the backspace key is pressed. If set to B<DEC>	1062	The string to send when the backspace key is pressed. If set to B<DEC>
942	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1063	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
943	(code 8) - which can be reversed with the appropriate DEC private mode	1064	(code 8) - which can be reversed with the appropriate DEC private mode
944	escape sequence.	1065	escape sequence.
945		1066
946	=item B<deletekey:> I<string>	1067	=item B<deletekey:> I<string>
947		1068
…		…
960	will be created). In this mode, characters outside ISO-8859-1 can be used.	1081	will be created). In this mode, characters outside ISO-8859-1 can be used.
961		1082
962	When the selection extension is not used, only ISO-8859-1 characters can	1083	When the selection extension is not used, only ISO-8859-1 characters can
963	be used. If not specified, the built-in default is used:	1084	be used. If not specified, the built-in default is used:
964		1085
965	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1086	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
966		1087
967	=item B<preeditType:> I<style>	1088	=item B<preeditType:> I<style>
968		1089
969	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1090	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
970		1091
…		…
1026		1147
1027	=item B<secondaryScroll:> I<boolean>	1148	=item B<secondaryScroll:> I<boolean>
1028		1149
1029	Turn on/off secondary screen scroll (default enabled). If this	1150	Turn on/off secondary screen scroll (default enabled). If this
1030	option is enabled, scrolls on the secondary screen will change the	1151	option is enabled, scrolls on the secondary screen will change the
1031	scrollback buffer and switching to/from the secondary screen will	1152	scrollback buffer and, when secondaryScreen is off, switching
1032	instead scroll the screen up.	1153	to/from the secondary screen will instead scroll the screen up.
1033		1154
1034	=item B<hold>: I<boolean>	1155	=item B<hold>: I<boolean>
1035		1156
1036	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1157	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1037	will not immediately destroy its window when the program executed within	1158	will not immediately destroy its window when the program executed within
1038	it exits. Instead, it will wait till it is being killed or closed by the	1159	it exits. Instead, it will wait till it is being killed or closed by the
1039	user.	1160	user.
		1161
		1162	=item B<chdir>: I<path>
		1163
		1164	Sets the working directory for the shell (or the command specified via
		1165	B<-e>). The I<path> must be an absolute path and it must exist for
		1166	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1167	directory will be used; option B<-cd>.
1040		1168
1041	=item B<keysym.>I<sym>: I<string>	1169	=item B<keysym.>I<sym>: I<string>
1042		1170
1043	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1171	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1044	intervening resource name B<keysym.> cannot be omitted.	1172	intervening resource name B<keysym.> cannot be omitted.
…		…
1058	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1186	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1059	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1187	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1060	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1188	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1061	performed in an exact manner; however, the closest match is assured.	1189	performed in an exact manner; however, the closest match is assured.
1062		1190
1063	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1191	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1064	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1192	number), see RESOURCES in C<man 7 X> for further details.
1065	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1066	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1067	can start or end with whitespace. B<This feature is deprecated and will
1068	be removed>.
1069		1193
1070	Please note that you need to double the C<\> in resource files, as
1071	Xlib itself does its own de-escaping (you can use C<\033> instead of
1072	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1073	processing).
1074
1075	You can define a range of keysyms in one shot by providing a I<string>	1194	You can define a range of keysyms in one shot by
		1195	loading the C<keysym-list> perl extension and providing a I<string>
1076	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1196	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1077	should be a character not used by the strings.	1197	should be a character not used by the strings.
1078		1198
1079	Its usage can be demonstrated by an example:	1199	Its usage can be demonstrated by an example:
1080		1200
1081	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1201	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1082		1202
1083	The above line is equivalent to the following three lines:	1203	The above line is equivalent to the following three lines:
1084		1204
1085	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1205	URxvt.keysym.Meta-Control-0x61: \033<a>
1086	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1206	URxvt.keysym.Meta-Control-0x62: \033<b>
1087	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1207	URxvt.keysym.Meta-Control-0x63: \033<c>
1088		1208
1089	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1209	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1090	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1210	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1091	example the following means "change the current locale to C<zh_CN.GBK>	1211	example the following means "change the current locale to C<zh_CN.GBK>
1092	when Control-Meta-c is being pressed":	1212	when Control-Meta-c is being pressed":
1093		1213
1094	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1214	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1095		1215
1096	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1216	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1097	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1217	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1098	manpage. For example, the F<selection> extension (activated via	1218	manpage. For example, the F<selection> extension (activated via
1099	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1219	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1100		1220
1101	URxvt.keysym.M-C-c: perl:selection:rot13	1221	URxvt.keysym.M-C-c: perl:selection:rot13
1102		1222
1103	Due the the large number of modifier combinations, a defined key mapping	1223	Due the the large number of modifier combinations, a defined key mapping
1104	will match if at I<at least> the specified identifiers are being set, and	1224	will match if I<at least> the specified identifiers are being set, and
1105	no other key mappings with those and more bits are being defined. That	1225	no other key mappings with those and more bits are being defined. That
1106	means that defining a key map for C<a> will automatically provide	1226	means that defining a key map for C<a> will automatically provide
1107	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1227	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1108	mappings themselves.	1228	mappings themselves.
1109		1229
…		…
1160	all instances, while B<perl-ext> is used for specific instances.	1280	all instances, while B<perl-ext> is used for specific instances.
1161		1281
1162	=item B<perl-eval>: I<string>	1282	=item B<perl-eval>: I<string>
1163		1283
1164	Perl code to be evaluated when all extensions have been registered. See	1284	Perl code to be evaluated when all extensions have been registered. See
1165	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1285	the @@RXVT_NAME@@perl(3) manpage.
1166	will be ignored when running setuid/setgid.
1167		1286
1168	=item B<perl-lib>: I<path>	1287	=item B<perl-lib>: I<path>
1169		1288
1170	Colon-separated list of additional directories that hold extension	1289	Colon-separated list of additional directories that hold extension
1171	scripts. When looking for extensions specified by the C<perl> resource,	1290	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1172	@@RXVT_NAME@@ will first look in these directories and then in	1291	look in these directories, then in $HOME/.urxvt/ext and lastly in
1173	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1292	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1174	will be ignored when running setuid/setgid.
1175		1293
1176	See the @@RXVT_NAME@@perl(3) manpage.	1294	See the @@RXVT_NAME@@perl(3) manpage.
1177		1295
1178	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1296	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1179		1297
…		…
1201		1319
1202	=item B<override-redirect>: I<boolean>	1320	=item B<override-redirect>: I<boolean>
1203		1321
1204	Compile I<frills>: Sets override-redirect for the terminal window, making	1322	Compile I<frills>: Sets override-redirect for the terminal window, making
1205	it almost invisible to window managers; option B<-override-redirect>.	1323	it almost invisible to window managers; option B<-override-redirect>.
		1324
		1325	=item B<iso14755:> I<boolean>
		1326
		1327	Turn on/off ISO 14755 (default enabled).
		1328
		1329	=item B<iso14755_52:> I<boolean>
		1330
		1331	Turn on/off ISO 14755 5.2 mode (default enabled).
1206		1332
1207	=back	1333	=back
1208		1334
1209	=head1 THE SCROLLBAR	1335	=head1 THE SCROLLBAR
1210		1336
…		…
1281		1407
1282	=head1 ISO 14755 SUPPORT	1408	=head1 ISO 14755 SUPPORT
1283		1409
1284	ISO 14755 is a standard for entering and viewing unicode characters	1410	ISO 14755 is a standard for entering and viewing unicode characters
1285	and character codes using the keyboard. It consists of 4 parts. The	1411	and character codes using the keyboard. It consists of 4 parts. The
1286	first part is available rxvt-unicode has been compiled with	1412	first part is available if rxvt-unicode has been compiled with
1287	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1413	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1288	with C<--enable-iso14755>.	1414	with C<--enable-iso14755>.
1289		1415
1290	=over 4	1416	=over 4
1291		1417
…		…
1349	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1475	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1350	it can be seen via the I<who(1)> command, and can accept messages. To	1476	it can be seen via the I<who(1)> command, and can accept messages. To
1351	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1477	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1352	on some systems or setgid to root or to some other group on others.	1478	on some systems or setgid to root or to some other group on others.
1353		1479
1354	=head1 COLORS AND GRAPHICS	1480	=head1 COLOURS AND GRAPHICS
1355		1481
1356	In addition to the default foreground and background colours,	1482	In addition to the default foreground and background colours,
1357	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1483	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1358	high-intensity bold/blink versions of the same). Here is a list of the	1484	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1359	colours with their names.	1485	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1486	cube plus a 8 (24) colour greyscale ramp.
		1487
		1488	Here is a list of the ANSI colours with their names.
1360		1489
1361	=begin table	1490	=begin table
1362		1491
1363	B<color0> (black) = Black	1492	B<color0> (black) = Black
1364	B<color1> (red) = Red3	1493	B<color1> (red) = Red3
…		…
1384	It is also possible to specify the colour values of B<foreground>,	1513	It is also possible to specify the colour values of B<foreground>,
1385	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1514	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1386	a number 0-15, as a convenient shorthand to reference the colour name of	1515	a number 0-15, as a convenient shorthand to reference the colour name of
1387	color0-color15.	1516	color0-color15.
1388		1517
1389	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1518	The following text gives values for the standard 88 colour mode (and
1390	additional 72 colours. The first 64 of those (with indices 16 to 79)	1519	values for the 256 colour mode in parentheses).
1391	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1392	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1393		1520
		1521	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1522
		1523	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1524	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1525
		1526	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1527	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1528	the RGB cube.
		1529
1394	Together, all those colours implement the 88 colour xterm colours. Only	1530	Together, all those colours implement the 88 (256) colour xterm
1395	the first 16 can be changed using resources currently, the rest can only	1531	colours. Only the first 16 can be changed using resources currently, the
1396	be changed via command sequences ("escape codes").	1532	rest can only be changed via command sequences ("escape codes").
		1533
		1534	Applications are advised to use terminfo or command sequences to discover
		1535	number and RGB values of all colours (yes, you can query this...).
1397		1536
1398	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1537	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1399	always swapping the foreground/background colours. This is in contrast to	1538	always swapping the foreground/background colours. This is in contrast to
1400	I<xterm>(1) where the colours are only swapped if they have not otherwise	1539	I<xterm>(1) where the colours are only swapped if they have not otherwise
1401	been specified. For example,	1540	been specified. For example,
1402		1541
1403	=over 4
1404
1405	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1542	@@RXVT_NAME@@ -fg Black -bg White -rv
1406		1543
1407	would yield White on Black, while on I<xterm>(1) it would yield Black	1544	would yield White on Black, while on I<xterm>(1) it would yield Black on
1408	on White.	1545	White.
1409
1410	=back
1411		1546
1412	=head2 ALPHA CHANNEL SUPPORT	1547	=head2 ALPHA CHANNEL SUPPORT
1413		1548
1414	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1549	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1415	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1550	their act together, rxvt-unicode will do its own alpha channel management:
1416	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1551
1417	in addition to the ones provided by X, where the additional A component	1552	You can prefix any colour with an opaqueness percentage enclosed in
		1553	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1554	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1555	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1556	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1557	is the recommended format to specify transparency values, and works with
		1558	all ways to specify a colour.
		1559
		1560	For complete control, rxvt-unicode also supports
		1561	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1562	specifications, where the additional C<aaaa> component specifies opacity
1418	specifies opacity (alpha) values. The minimum value of C<0> is completely	1563	(alpha) values. The minimum value of C<0000> is completely transparent,
1419	transparent). You can also prefix any color with C<[percent]>, where	1564	while C<ffff> is completely opaque). The two example colours from
1420	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1565	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1421	the color, where C<0> is completely transparent and C<100> is completelxy	1566	C<rgba:0000/ff00/0000/f332>.
1422	opaque.
1423		1567
1424	You probably need to specify B<"-depth 32">, too, and have the luck that	1568	You probably need to specify B<"-depth 32">, too, to force a visual with
1425	your X-server uses ARGB pixel layout, as X is far from just supporting	1569	alpha channels, and have the luck that your X-server uses ARGB pixel
1426	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1570	layout, as X is far from just supporting ARGB visuals out of the box, and
		1571	rxvt-unicode just fudges around.
1427		1572
1428	For example, the following selects an almost completely transparent red	1573	For example, the following selects an almost completely transparent black
1429	background, and an almost opaque pink foreground:	1574	background, and an almost opaque pink foreground:
1430		1575
1431	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1576	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1432		1577
1433	I<Please note that transparency of any kind if completely unsupported by	1578	When not using a background image, then the interpretation of the
1434	the author. Don't bug him with installation questions!>	1579	alpha channel is up to your compositing manager (most interpret it as
		1580	transparency of course).
		1581
		1582	When using a background pixmap or pseudo-transparency, then the background
		1583	colour will always behave as if it were completely transparent (so the
		1584	background image shows instead), regardless of how it was specified, while
		1585	other colours will either be transparent as specified (the background
		1586	image will show through) on servers supporting the RENDER extension, or
		1587	fully opaque on servers not supporting the RENDER EXTENSION.
		1588
		1589	Please note that due to bugs in Xft, specifying alpha values might result
		1590	in garbage being displayed when the X-server does not support the RENDER
		1591	extension.
1435		1592
1436	=head1 ENVIRONMENT	1593	=head1 ENVIRONMENT
1437		1594
1438	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1595	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1439		1596
…		…
1445	resources or on the command line.	1602	resources or on the command line.
1446		1603
1447	=item B<COLORTERM>	1604	=item B<COLORTERM>
1448		1605
1449	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1606	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1450	compiled with XPM support, and optionally with the added extension	1607	compiled with background image support, and optionally with the added
1451	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1608	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1609	screen.
1452		1610
1453	=item B<COLORFGBG>	1611	=item B<COLORFGBG>
1454		1612
1455	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1613	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1456	the colour code used as default foreground/text colour (or the string	1614	the colour code used as default foreground/text colour (or the string
1457	C<default> to indicate that the default-colour escape sequence is to be	1615	C<default> to indicate that the default-colour escape sequence is to be
1458	used), C<bg> is the colour code used as default background colour (or the	1616	used), C<bg> is the colour code used as default background colour (or the
1459	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1617	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1460	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1618	was compiled with background image support. Libraries like C<ncurses>
1461	(and do) use this information to optimize screen output.	1619	and C<slang> can (and do) use this information to optimize screen output.
1462		1620
1463	=item B<WINDOWID>	1621	=item B<WINDOWID>
1464		1622
1465	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1623	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1466	window, which usually has subwindows for the scrollbar, the terminal	1624	window, which usually has subwindows for the scrollbar, the terminal
…		…
1472	C<--with-terminfo=PATH>.	1630	C<--with-terminfo=PATH>.
1473		1631
1474	=item B<DISPLAY>	1632	=item B<DISPLAY>
1475		1633
1476	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1634	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1477	display in its child processes.	1635	display in its child processes if C<-display> isn't used to override. It
		1636	defaults to C<:0> if it doesn't exist.
1478		1637
1479	=item B<SHELL>	1638	=item B<SHELL>
1480		1639
1481	The shell to be used for command execution, defaults to C</bin/sh>.	1640	The shell to be used for command execution, defaults to C</bin/sh>.
1482		1641
1483	=item B<RXVT_SOCKET>	1642	=item B<RXVT_SOCKET>
1484		1643
1485	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1644	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1486	@@RXVT_NAME@@d(1).	1645	@@RXVT_NAME@@d(1).
1487		1646
1488	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1647	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1489		1648
1490	=item B<HOME>	1649	=item B<HOME>
1491		1650
1492	Used to locate the default directory for the unix domain socket for	1651	Used to locate the default directory for the unix domain socket for
1493	daemon communications and to locate various resource files (such as	1652	daemon communications and to locate various resource files (such as
1494	C<.Xdefaults>)	1653	C<.Xdefaults>)
1495		1654
1496	=item B<XAPPLRESDIR>	1655	=item B<XAPPLRESDIR>
1497		1656
1498	Directory where various X resource files are being located.	1657	Directory where application-specific X resource files are located.
1499		1658
1500	=item B<XENVIRONMENT>	1659	=item B<XENVIRONMENT>
1501		1660
1502	If set and accessible, gives the name of a X resource file to be loaded by	1661	If set and accessible, gives the name of a X resource file to be loaded by
1503	@@RXVT_NAME@@.	1662	@@RXVT_NAME@@.
…		…
1508		1667
1509	=over 4	1668	=over 4
1510		1669
1511	=item B</usr/lib/X11/rgb.txt>	1670	=item B</usr/lib/X11/rgb.txt>
1512		1671
1513	Color names.	1672	Colour names.
1514		1673
1515	=back	1674	=back
1516		1675
1517	=head1 SEE ALSO	1676	=head1 SEE ALSO
1518		1677
…		…
1557	Project Coordinator (changes.txt 2.21a to 2.4.5)	1716	Project Coordinator (changes.txt 2.21a to 2.4.5)
1558		1717
1559	=item Geoff Wing L<< <gcw@pobox.com> >>	1718	=item Geoff Wing L<< <gcw@pobox.com> >>
1560		1719
1561	Rewrote screen display and text selection routines.	1720	Rewrote screen display and text selection routines.
1562		1721
1563	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1722	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1564		1723
1565	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1724	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1566		1725
1567	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1726	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1569		1728
1570	Project Coordinator (Changes 1.0 -)	1729	Project Coordinator (Changes 1.0 -)
1571		1730
1572	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1731	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1573		1732
1574	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1733	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1575		1734
1576	=back	1735	=back
1577		1736

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 UTC vs. Revision 1.215 by sf-exg, Sun May 20 16:34:42 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 UTC vs.
Revision 1.215 by sf-exg, Sun May 20 16:34:42 2012 UTC