[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.212 by sf-exg, Sun Jan 1 14:31:28 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<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	150	=item B<-sh> I<number>
144		151
145	=item B<-sh>
146
147	I<number> 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 tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
149	specified, too, e.g. C<-tint white>).	154
		155	=item B<-blt> I<string>
		156
		157	Specify background blending type. If background pixmap is specified
		158	at the same time as transparency - such pixmap will be blended over
		159	the transparent background, using the method specified. Supported values are:
		160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
		161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		164
		165	=item B<-blr> I<HxV>
		166
		167	Apply Gaussian Blur with the specified radii to the transparent
		168	background. If a single number is specified, the vertical and
		169	horizontal radii are considered to be the same. Setting one of the
		170	radii to 1 and the other to a large number creates interesting effects
		171	on some backgrounds. The maximum radius value is 128. An horizontal or
		172	vertical radius of 0 disables blurring;
		173	resource I<blurRadius>.
		174
		175	=item B<-icon> I<file>
		176
		177	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		178	is used by many window managers, taskbars and pagers to represent the
		179	application window; resource I<iconFile>.
150		180
151	=item B<-bg> I<colour>	181	=item B<-bg> I<colour>
152		182
153	Window background colour; resource B<background>.	183	Window background colour; resource B<background>.
154		184
155	=item B<-fg> I<colour>	185	=item B<-fg> I<colour>
156		186
157	Window foreground colour; resource B<foreground>.	187	Window foreground colour; resource B<foreground>.
158		188
159	=item B<-pixmap> I<file[;geom]>	189	=item B<-pixmap> I<file[;oplist]>
160		190
161	Compile I<XPM>: Specify XPM file for the background and also optionally	191	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
162	specify its scaling with a geometry string. Note you may need to	192	optionally specify a list of operations to modify it. Note you may need to
163	add quotes to avoid special shell interpretation of the C<;> in the	193	add quotes to avoid special shell interpretation of the C<;> in the
164	command-line; resource B<backgroundPixmap>.	194	command-line; for more details see resource B<backgroundPixmap>.
165		195
166	=item B<-cr> I<colour>	196	=item B<-cr> I<colour>
167		197
168	The cursor colour; resource B<cursorColor>.	198	The cursor colour; resource B<cursorColor>.
169		199
…		…
214	italic> >> characters are to be printed. See resource B<boldItalicFont>	244	italic> >> characters are to be printed. See resource B<boldItalicFont>
215	for details.	245	for details.
216		246
217	=item B<-is>\|B<+is>	247	=item B<-is>\|B<+is>
218		248
219	Compile I<font-styles>: Bold/Italic font styles imply high intensity	249	Compile I<font-styles>: Bold/Blink font styles imply high intensity
220	foreground/background (default). See resource B<intensityStyles> for	250	foreground/background (default). See resource B<intensityStyles> for
221	details.	251	details.
222		252
223	=item B<-name> I<name>	253	=item B<-name> I<name>
224		254
…		…
242		272
243	=item B<-sb>\|B<+sb>	273	=item B<-sb>\|B<+sb>
244		274
245	Turn on/off scrollbar; resource B<scrollBar>.	275	Turn on/off scrollbar; resource B<scrollBar>.
246		276
		277	=item B<-sr>\|B<+sr>
		278
		279	Put scrollbar on right/left; resource B<scrollBar_right>.
		280
		281	=item B<-st>\|B<+st>
		282
		283	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		284	resource B<scrollBar_floating>.
		285
247	=item B<-si>\|B<+si>	286	=item B<-si>\|B<+si>
248		287
249	Turn on/off scroll-to-bottom on TTY output inhibit; resource	288	Turn on/off scroll-to-bottom on TTY output inhibit; resource
250	B<scrollTtyOutput> has opposite effect.	289	B<scrollTtyOutput> has opposite effect.
251		290
…		…
257	=item B<-sw>\|B<+sw>	296	=item B<-sw>\|B<+sw>
258		297
259	Turn on/off scrolling with the scrollback buffer as new lines appear.	298	Turn on/off scrolling with the scrollback buffer as new lines appear.
260	This only takes effect if B<-si> is also given; resource	299	This only takes effect if B<-si> is also given; resource
261	B<scrollWithBuffer>.	300	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		301
272	=item B<-ptab>\|B<+ptab>	302	=item B<-ptab>\|B<+ptab>
273		303
274	If enabled (default), "Horizontal Tab" characters are being stored as	304	If enabled (default), "Horizontal Tab" characters are being stored as
275	actual wide characters in the screen buffer, which makes it possible to	305	actual wide characters in the screen buffer, which makes it possible to
…		…
279		309
280	=item B<-bc>\|B<+bc>	310	=item B<-bc>\|B<+bc>
281		311
282	Blink the cursor; resource B<cursorBlink>.	312	Blink the cursor; resource B<cursorBlink>.
283		313
		314	=item B<-uc>\|B<+uc>
		315
		316	Make the cursor underlined; resource B<cursorUnderline>.
		317
284	=item B<-iconic>	318	=item B<-iconic>
285		319
286	Start iconified, if the window manager supports that option.	320	Start iconified, if the window manager supports that option.
287	Alternative form is B<-ic>.	321	Alternative form is B<-ic>.
288		322
…		…
304		338
305	=item B<-bl>	339	=item B<-bl>
306		340
307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	341	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	342	if honoured by the WM, the rxvt-unicode window will not have window
309	decorations; resource B<borderLess>.	343	decorations; resource B<borderLess>. If the window manager does not
		344	support MWM hints (e.g. kwin), enables override-redirect mode.
310		345
311	=item B<-override-redirect>	346	=item B<-override-redirect>
312		347
313	Compile I<frills>: Sets override-redirect on the window; resource	348	Compile I<frills>: Sets override-redirect on the window; resource
314	B<override-redirect>.	349	B<override-redirect>.
…		…
322		357
323	=item B<-lsp> I<number>	358	=item B<-lsp> I<number>
324		359
325	Compile I<frills>: Lines (pixel height) to insert between each row of	360	Compile I<frills>: Lines (pixel height) to insert between each row of
326	the display. Useful to work around font rendering problems; resource	361	the display. Useful to work around font rendering problems; resource
327	B<linespace>.	362	B<lineSpace>.
		363
		364	=item B<-letsp> I<number>
		365
		366	Compile I<frills>: Amount to adjust the computed character width by
		367	to control overall letter spacing. Negative values will tighten up the
		368	letter spacing, positive values will space letters out more. Useful to
		369	work around odd font metrics; resource B<letterSpace>.
328		370
329	=item B<-tn> I<termname>	371	=item B<-tn> I<termname>
330		372
331	This option specifies the name of the terminal type to be set in the	373	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	374	B<TERM> environment variable. This terminal type must exist in the
…		…
386	for more info.	428	for more info.
387		429
388	=item B<-tcw>	430	=item B<-tcw>
389		431
390	Change the meaning of triple-click selection with the left mouse	432	Change the meaning of triple-click selection with the left mouse
		433	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	434	in-use. Instead of selecting a full line it will extend the selection to
392	end of the logical line only. resource B<tripleclickwords>.	435	the end of the logical line only. resource B<tripleclickwords>.
393		436
394	=item B<-insecure>	437	=item B<-insecure>
395		438
396	Enable "insecure" mode, which currently enables most of the escape	439	Enable "insecure" mode, which currently enables most of the escape
397	sequences that echo strings. See the resource B<insecure> for more	440	sequences that echo strings. See the resource B<insecure> for more
…		…
417		460
418	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	461	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419	will not immediately destroy its window when the program executed within	462	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	463	it exits. Instead, it will wait till it is being killed or closed by the
421	user; resource B<hold>.	464	user; resource B<hold>.
		465
		466	=item B<-cd> I<path>
		467
		468	Sets the working directory for the shell (or the command specified via
		469	B<-e>). The I<path> must be an absolute path and it must exist for
		470	@@RXVT_NAME@@ to start; resource B<chdir>.
		471
		472	=item B<-xrm> I<string>
		473
		474	Works like the X Toolkit option of the same name, by adding the I<string>
		475	as if it were specified in a resource file. Resource values specified this
		476	way take precedence over all other resource specifications.
		477
		478	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		479	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		480	options can be specified as long-options on the commandline, so use
		481	of B<-xrm> is mostly limited to cases where you want to specify other
		482	resources (e.g. for input methods) or for compatibility with other
		483	programs.
422		484
423	=item B<-keysym.>I<sym> I<string>	485	=item B<-keysym.>I<sym> I<string>
424		486
425	Remap a key symbol. See resource B<keysym>.	487	Remap a key symbol. See resource B<keysym>.
426		488
…		…
461	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	523	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	524	entries and will not tinker with pty/tty permissions - you have to do that
463	yourself if you want that.	525	yourself if you want that.
464		526
465	As an extremely special case, specifying C<-1> will completely suppress	527	As an extremely special case, specifying C<-1> will completely suppress
466	pty/tty operations.	528	pty/tty operations, which is probably only useful in conjunction with some
		529	perl extension that manages the terminal.
467		530
468	Here is a example in perl that illustrates how this option can be used (a	531	Here is a example in perl that illustrates how this option can be used (a
469	longer example is in F<doc/pty-fd>):	532	longer example is in F<doc/pty-fd>):
470		533
471	use IO::Pty;	534	use IO::Pty;
…		…
485	Comma-separated list of perl extension scripts to use (or not to use) in	548	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.	549	this terminal instance. See resource B<perl-ext> for details.
487		550
488	=back	551	=back
489		552
490	=head1 RESOURCES (available also as long-options)	553	=head1 RESOURCES
491		554
492	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	555	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493	options) compiled into your version.	556	options) compiled into your version. All resources are also available as
		557	long-options.
494		558
495	You can set and change the resources using X11 tools like B<xrdb>. Many	559	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	560	distribution do also load settings from the B<~/.Xresources> file when X
497	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	561	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498	with later settings overwriting earlier ones:	562	with later settings overwriting earlier ones:
499		563
500	1. system-wide app-defaults file, either locale-dependent OR global
501	2. app-defaults file in $XAPPLRESDIR	564	1. app-defaults file in $XAPPLRESDIR
		565	2. $HOME/.Xdefaults
502	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	566	3. RESOURCE_MANAGER property on root-window of screen 0
503	4. SCREEN_RESOURCES for the current screen	567	4. SCREEN_RESOURCES property on root-window of the current screen
504	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	568	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		569	6. resources specified via -xrm on the commandline
505		570
506	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	571	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	572	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	573	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	574	configured, while the class name B<URxvt> allows resources unique to
…		…
519	=item B<depth:> I<bitdepth>	584	=item B<depth:> I<bitdepth>
520		585
521	Compile I<xft>: Attempt to find a visual with the given bit depth;	586	Compile I<xft>: Attempt to find a visual with the given bit depth;
522	option B<-depth>.	587	option B<-depth>.
523		588
		589	=item B<buffered:> I<boolean>
		590
		591	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		592	On some card/driver combination enabling it slightly decreases
		593	performance, on most it greatly helps it. The slowdown is small, so it
		594	should normally be enabled.
		595
524	=item B<geometry:> I<geom>	596	=item B<geometry:> I<geom>
525		597
526	Create the window with the specified X window geometry [default 80x24];	598	Create the window with the specified X window geometry [default 80x24];
527	option B<-geometry>.	599	option B<-geometry>.
528		600
…		…
541	Use the specified colour for the colour value I<n>, where 0-7	613	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	614	corresponds to low-intensity (normal) colours and 8-15 corresponds to
543	high-intensity (bold = bright foreground, blink = bright background)	615	high-intensity (bold = bright foreground, blink = bright background)
544	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	616	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	617	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.	618	names used are listed in the B<COLOURS AND GRAPHICS> section.
547		619
548	Colours higher than 15 cannot be set using resources (yet), but can be	620	Colours higher than 15 cannot be set using resources (yet), but can be
549	changed using an escape command (see @@RXVT_NAME@@(7)).	621	changed using an escape command (see @@RXVT_NAME@@(7)).
550		622
551	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	623	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
562	=item B<colorUL:> I<colour>	634	=item B<colorUL:> I<colour>
563		635
564	Use the specified colour to display underlined characters when the	636	Use the specified colour to display underlined characters when the
565	foreground colour is the default.	637	foreground colour is the default.
566		638
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>	639	=item B<underlineColor:> I<colour>
573		640
574	If set, use the specified colour as the colour for the underline	641	If set, use the specified colour as the colour for the underline
575	itself. If unset, use the foreground colour.	642	itself. If unset, use the foreground colour.
		643
		644	=item B<highlightColor:> I<colour>
		645
		646	If set, use the specified colour as the background for highlighted
		647	characters. If unset, use reverse video.
		648
		649	=item B<highlightTextColor:> I<colour>
		650
		651	If set and highlightColor is set, use the specified colour as the
		652	foreground for highlighted characters.
576		653
577	=item B<cursorColor:> I<colour>	654	=item B<cursorColor:> I<colour>
578		655
579	Use the specified colour for the cursor. The default is to use the	656	Use the specified colour for the cursor. The default is to use the
580	foreground colour; option B<-cr>.	657	foreground colour; option B<-cr>.
…		…
587		664
588	=item B<reverseVideo:> I<boolean>	665	=item B<reverseVideo:> I<boolean>
589		666
590	B<True>: simulate reverse video by foreground and background colours;	667	B<True>: simulate reverse video by foreground and background colours;
591	option B<-rv>. B<False>: regular screen colours [default]; option	668	option B<-rv>. B<False>: regular screen colours [default]; option
592	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	669	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593		670
594	=item B<jumpScroll:> I<boolean>	671	=item B<jumpScroll:> I<boolean>
595		672
596	B<True>: specify that jump scrolling should be used. When scrolling	673	B<True>: specify that jump scrolling should be used. When receiving lots
597	quickly, fewer screen updates are performed [default]; option B<-j>.	674	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		675	has been read, resulting in fewer updates while still displaying every
		676	received line; option B<-j>.
		677
598	B<False>: specify that smooth scrolling should be used; option B<+j>.	678	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		679	force a screen refresh on each new line it received; option B<+j>.
599		680
600	=item B<inheritPixmap:> I<boolean>	681	=item B<skipScroll:> I<boolean>
601		682
602	B<True>: make the background inherit the parent windows' pixmap, giving	683	B<True>: (the default) specify that skip scrolling should be used. When
603	artificial transparency. B<False>: do not inherit the parent windows'	684	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604	pixmap.	685	(around 60 times per second), resulting in far fewer updates. This can
		686	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		687	option B<-ss>.
605		688
606	I<Please note that transparency of any kind if completely unsupported by	689	B<False>: specify that everything is to be displayed, even
607	the author. Don't bug him with installation questions!>	690	if the refresh is too fast for the human eye to read anything (or the
		691	monitor to display anything); option B<+ss>.
		692
		693	=item B<transparent:> I<boolean>
		694
		695	Turn on/off pseudo-transparency by using the root pixmap as background.
		696
		697	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		698	future versions.
608		699
609	=item B<fading:> I<number>	700	=item B<fading:> I<number>
610		701
611	Fade the text by the given percentage when focus is lost; option B<-fade>.	702	Fade the text by the given percentage when focus is lost; option B<-fade>.
612		703
…		…
615	Fade to this colour, when fading is used (see B<fading:>). The default	706	Fade to this colour, when fading is used (see B<fading:>). The default
616	colour is black; option B<-fadecolor>.	707	colour is black; option B<-fadecolor>.
617		708
618	=item B<tintColor:> I<colour>	709	=item B<tintColor:> I<colour>
619		710
620	Tint the transparent background pixmap with the given colour; option	711	Tint the transparent background with the given colour. If the RENDER
621	B<-tint>.	712	extension is not available only black, red, green, yellow, blue,
		713	magenta, cyan and white tints can be performed server-side. Note that
		714	a black tint yields a completely black image while a white tint yields
		715	the image unchanged; option B<-tint>.
622		716
623	=item B<shading:> I<number>	717	=item B<shading:> I<number>
624		718
625	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	719	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
626	image in addition to tinting it.	720	A value of 100 means no shading; option B<-sh>.
		721
		722	=item B<blendType:> I<string>
		723
		724	Specify background blending type; option B<-blt>.
		725
		726	=item B<blurRadius:> I<number>
		727
		728	Apply gaussian blur with the specified radius to the transparent
		729	background; option B<-blr>.
		730
		731	=item B<iconFile:> I<file>
		732
		733	Set the application icon pixmap; option B<-icon>.
627		734
628	=item B<scrollColor:> I<colour>	735	=item B<scrollColor:> I<colour>
629		736
630	Use the specified colour for the scrollbar [default #B2B2B2].	737	Use the specified colour for the scrollbar [default #B2B2B2].
631		738
…		…
637	=item B<borderColor:> I<colour>	744	=item B<borderColor:> I<colour>
638		745
639	The colour of the border around the text area and between the scrollbar	746	The colour of the border around the text area and between the scrollbar
640	and the text.	747	and the text.
641		748
642	=item B<backgroundPixmap:> I<file[;geom]>	749	=item B<backgroundPixmap:> I<file[;oplist]>
643		750
644	Use the specified XPM file (note the `.xpm' extension is optional) for	751	Use the specified image file for the background and also
645	the background and also optionally specify its scaling with a geometry	752	optionally specify a colon separated list of operations to modify it.
646	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	753	Supported operations are:
647	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	754
648	centre (percent). A scale of 0 displays the image with tiling. A scale	755	=over 4
649	of 1 displays the image without any scaling. A scale of 2 to 9	756
650	specifies an integer number of images in that direction. No image will	757	=item B<WxH+X+Y>
651	be magnified beyond 10 times its original size. The maximum permitted	758
652	scale is 1000. [default 0x0+50+50]	759	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		760	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		761	scale of 0 disables scaling. The maximum permitted scale is 1000.
		762
		763	=item B<op=tile>
		764
		765	enables tiling
		766
		767	=item B<op=keep-aspect>
		768
		769	maintain the image aspect ratio when scaling
		770
		771	=item B<op=root-align>
		772
		773	use the position of the terminal window relative to the root window as
		774	the image offset, simulating a root window background
		775
		776	=back
		777
		778	The default scale and position setting is C<100x100+50+50>.
		779	Alternatively, a predefined set of templates can be used to achieve
		780	the most common setups:
		781
		782	=over 4
		783
		784	=item B<style=tiled>
		785
		786	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		787
		788	=item B<style=aspect-stretched>
		789
		790	the image is scaled to fill the whole window maintaining the aspect
		791	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		792
		793	=item B<style=stretched>
		794
		795	the image is scaled to fill the whole window. Equivalent to 100x100
		796
		797	=item B<style=centered>
		798
		799	the image is centered with no scaling. Equivalent to 0x0+50+50
		800
		801	=item B<style=root-tiled>
		802
		803	the image is tiled with no scaling and using 'root' positioning.
		804	Equivalent to 0x0:op=tile:op=root-align
		805
		806	=back
		807
		808	If multiple templates are specified the last one wins. Note that a
		809	template overrides all the scale, position and operations settings.
		810
		811	If used in conjunction with B<-tr> option, the specified pixmap will be
		812	blended over the transparent background using alpha-blending. If I<afterimage>
		813	support has been compiled in it is possible to choose other blending
		814	types with B<-blt "type"> option.
653		815
654	=item B<path:> I<path>	816	=item B<path:> I<path>
655		817
656	Specify the colon-delimited search path for finding XPM files.	818	Specify the colon-delimited search path for finding background image files.
657		819
658	=item B<font:> I<fontlist>	820	=item B<font:> I<fontlist>
659		821
660	Select the fonts to be used. This is a comma separated list of font names	822	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	823	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	846	it is named first) and thus defines the character cell grid to be 9 pixels
685	wide and 15 pixels high.	847	wide and 15 pixels high.
686		848
687	The second font is just used to add additional unicode characters not in	849	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	850	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	851	the bold version of the font does contain fewer characters, so this is a
690	useful supplement.	852	useful supplement.
691		853
692	The third font is an Xft font with aliasing turned off, and the characters	854	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	855	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.	856	contains other characters, but we are not interested in them.
…		…
718	text font will being used for the given style.	880	text font will being used for the given style.
719		881
720	=item B<intensityStyles:> I<boolean>	882	=item B<intensityStyles:> I<boolean>
721		883
722	When font styles are not enabled, or this option is enabled (B<True>,	884	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	885	option B<-is>, the default), bold/blink font styles imply high
724	intensity foreground/background colours. Disabling this option (B<False>,	886	intensity foreground/background colours. Disabling this option (B<False>,
725	option B<+is>) disables this behaviour, the high intensity colours are not	887	option B<+is>) disables this behaviour, the high intensity colours are not
726	reachable.	888	reachable.
727		889
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>	890	=item B<title:> I<string>
740		891
741	Set window title string, the default title is the command-line	892	Set window title string, the default title is the command-line
742	specified after the B<-e> option, if any, otherwise the application	893	specified after the B<-e> option, if any, otherwise the application
743	name; option B<-title>.	894	name; option B<-title>.
…		…
751	=item B<mapAlert:> I<boolean>	902	=item B<mapAlert:> I<boolean>
752		903
753	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	904	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].	905	de-iconify (map) on receipt of a bell character [default].
755		906
		907	=item B<urgentOnBell:> I<boolean>
		908
		909	B<True>: set the urgency hint for the wm on receipt of a bell character.
		910	B<False>: do not set the urgency hint [default].
		911
		912	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		913
756	=item B<visualBell:> I<boolean>	914	=item B<visualBell:> I<boolean>
757		915
758	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	916	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759	B<False>: no visual bell [default]; option B<+vb>.	917	B<False>: no visual bell [default]; option B<+vb>.
760		918
…		…
783	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	941	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784		942
785	This creates a new file in your home directory with the screen contents	943	This creates a new file in your home directory with the screen contents
786	every time you hit C<Print>.	944	every time you hit C<Print>.
787		945
		946	=item B<scrollstyle:> I<mode>
		947
		948	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		949	the author's favourite.
		950
		951	=item B<thickness:> I<number>
		952
		953	Set the scrollbar width in pixels.
		954
788	=item B<scrollBar:> I<boolean>	955	=item B<scrollBar:> I<boolean>
789		956
790	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	957	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791	disable the scrollbar; option B<+sb>.	958	disable the scrollbar; option B<+sb>.
792		959
…		…
811	B<False>: do not scroll to bottom when tty receives output; option	978	B<False>: do not scroll to bottom when tty receives output; option
812	B<+si>.	979	B<+si>.
813		980
814	=item B<scrollWithBuffer:> I<boolean>	981	=item B<scrollWithBuffer:> I<boolean>
815		982
816	B<True>: scroll with scrollback buffer when tty receives new lines (and	983	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	984	try to show the same lines) and B<scrollTtyOutput> is False; option
818	with scrollback buffer when tty receives new lines; option B<+sw>.	985	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		986	new lines; option B<+sw>.
819		987
820	=item B<scrollTtyKeypress:> I<boolean>	988	=item B<scrollTtyKeypress:> I<boolean>
821		989
822	B<True>: scroll to bottom when a non-special key is pressed. Special keys	990	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	991	are those which are intercepted by rxvt-unicode for special handling and
…		…
854	=item B<termName:> I<termname>	1022	=item B<termName:> I<termname>
855		1023
856	Specifies the terminal type name to be set in the B<TERM> environment	1024	Specifies the terminal type name to be set in the B<TERM> environment
857	variable; option B<-tn>.	1025	variable; option B<-tn>.
858		1026
859	=item B<linespace:> I<number>	1027	=item B<lineSpace:> I<number>
860		1028
861	Specifies number of lines (pixel height) to insert between each row of	1029	Specifies number of lines (pixel height) to insert between each row of
862	the display [default 0]; option B<-lsp>.	1030	the display [default 0]; option B<-lsp>.
863		1031
864	=item B<meta8:> I<boolean>	1032	=item B<meta8:> I<boolean>
…		…
878		1046
879	=item B<cursorBlink:> I<boolean>	1047	=item B<cursorBlink:> I<boolean>
880		1048
881	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1049	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
882	option B<-bc>.	1050	option B<-bc>.
		1051
		1052	=item B<cursorUnderline:> I<boolean>
		1053
		1054	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1055	option B<-uc>.
883		1056
884	=item B<pointerBlank:> I<boolean>	1057	=item B<pointerBlank:> I<boolean>
885		1058
886	B<True>: blank the pointer when a key is pressed or after a set number	1059	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	1060	of seconds of inactivity. B<False>: the pointer is always visible
…		…
901	large number (e.g. C<987654321>) to effectively disable the timeout.	1074	large number (e.g. C<987654321>) to effectively disable the timeout.
902		1075
903	=item B<backspacekey:> I<string>	1076	=item B<backspacekey:> I<string>
904		1077
905	The string to send when the backspace key is pressed. If set to B<DEC>	1078	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>	1079	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	1080	(code 8) - which can be reversed with the appropriate DEC private mode
908	escape sequence.	1081	escape sequence.
909		1082
910	=item B<deletekey:> I<string>	1083	=item B<deletekey:> I<string>
911		1084
…		…
916	=item B<cutchars:> I<string>	1089	=item B<cutchars:> I<string>
917		1090
918	The characters used as delimiters for double-click word selection	1091	The characters used as delimiters for double-click word selection
919	(whitespace delimiting is added automatically if resource is given).	1092	(whitespace delimiting is added automatically if resource is given).
920		1093
921	When the selection extension is in use (the default if compiled in, see	1094	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	1095	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	1096	characters will be created (if the resource exists, otherwise, no regex
924	created). In this mode, characters outside ISO-8859-1 can be used.	1097	will be created). In this mode, characters outside ISO-8859-1 can be used.
925		1098
926	When the selection extension is not used, only ISO-8859-1 characters can	1099	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:	1100	be used. If not specified, the built-in default is used:
928		1101
929	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1102	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
930		1103
931	=item B<preeditType:> I<style>	1104	=item B<preeditType:> I<style>
932		1105
933	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1106	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934		1107
…		…
988		1161
989	Turn on/off secondary screen (default enabled).	1162	Turn on/off secondary screen (default enabled).
990		1163
991	=item B<secondaryScroll:> I<boolean>	1164	=item B<secondaryScroll:> I<boolean>
992		1165
993	Turn on/off secondary screen scroll (default enabled). If the this	1166	Turn on/off secondary screen scroll (default enabled). If this
994	option is enabled, scrolls on the secondary screen will change the	1167	option is enabled, scrolls on the secondary screen will change the
995	scrollback buffer and switching to/from the secondary screen will	1168	scrollback buffer and, when secondaryScreen is off, switching
996	instead scroll the screen up.	1169	to/from the secondary screen will instead scroll the screen up.
997		1170
998	=item B<hold>: I<boolean>	1171	=item B<hold>: I<boolean>
999		1172
1000	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1173	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001	will not immediately destroy its window when the program executed within	1174	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	1175	it exits. Instead, it will wait till it is being killed or closed by the
1003	user.	1176	user.
		1177
		1178	=item B<chdir>: I<path>
		1179
		1180	Sets the working directory for the shell (or the command specified via
		1181	B<-e>). The I<path> must be an absolute path and it must exist for
		1182	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1183	directory will be used; option B<-cd>.
1004		1184
1005	=item B<keysym.>I<sym>: I<string>	1185	=item B<keysym.>I<sym>: I<string>
1006		1186
1007	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1187	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1008	intervening resource name B<keysym.> cannot be omitted.	1188	intervening resource name B<keysym.> cannot be omitted.
…		…
1022	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1202	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	1203	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	1204	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.	1205	performed in an exact manner; however, the closest match is assured.
1026		1206
1027	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1207	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,	1208	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		1209
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>	1210	You can define a range of keysyms in one shot by
		1211	loading the C<keysym-list> perl extension and providing a I<string>
1039	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1212	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1040	should be a character not used by the strings.	1213	should be a character not used by the strings.
1041		1214
1042	Its usage can be demonstrated by an example:	1215	Its usage can be demonstrated by an example:
1043		1216
1044	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1217	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1045		1218
1046	The above line is equivalent to the following three lines:	1219	The above line is equivalent to the following three lines:
1047		1220
1048	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1221	URxvt.keysym.Meta-Control-0x61: \033<a>
1049	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1222	URxvt.keysym.Meta-Control-0x62: \033<b>
1050	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1223	URxvt.keysym.Meta-Control-0x63: \033<c>
1051		1224
1052	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1225	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	1226	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>	1227	example the following means "change the current locale to C<zh_CN.GBK>
1055	when Control-Meta-c is being pressed":	1228	when Control-Meta-c is being pressed":
1056		1229
1057	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1230	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1058		1231
1059	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1232	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)	1233	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	1234	manpage. For example, the F<selection> extension (activated via
1062	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1235	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1063		1236
1064	URxvt.keysym.M-C-c: perl:selection:rot13	1237	URxvt.keysym.M-C-c: perl:selection:rot13
1065		1238
1066	Due the the large number of modifier combinations, a defined key mapping	1239	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	1240	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	1241	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	1242	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	1243	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1071	mappings themselves.	1244	mappings themselves.
1072		1245
…		…
1123	all instances, while B<perl-ext> is used for specific instances.	1296	all instances, while B<perl-ext> is used for specific instances.
1124		1297
1125	=item B<perl-eval>: I<string>	1298	=item B<perl-eval>: I<string>
1126		1299
1127	Perl code to be evaluated when all extensions have been registered. See	1300	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	1301	the @@RXVT_NAME@@perl(3) manpage.
1129	will be ignored when running setuid/setgid.
1130		1302
1131	=item B<perl-lib>: I<path>	1303	=item B<perl-lib>: I<path>
1132		1304
1133	Colon-separated list of additional directories that hold extension	1305	Colon-separated list of additional directories that hold extension
1134	scripts. When looking for extensions specified by the C<perl> resource,	1306	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1135	@@RXVT_NAME@@ will first look in these directories and then in	1307	look in these directories, then in $HOME/.urxvt/ext and lastly in
1136	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1308	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1137	will be ignored when running setuid/setgid.
1138		1309
1139	See the @@RXVT_NAME@@perl(3) manpage.	1310	See the @@RXVT_NAME@@perl(3) manpage.
1140		1311
1141	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1312	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1142		1313
…		…
1154	(default: C<M-s>).	1325	(default: C<M-s>).
1155		1326
1156	=item B<urlLauncher>: I<string>	1327	=item B<urlLauncher>: I<string>
1157		1328
1158	Specifies the program to be started with a URL argument. Used by the	1329	Specifies the program to be started with a URL argument. Used by the
1159	C<selection-popup> and C<mark-urls> perl extensions.	1330	C<selection-popup> and C<matcher> perl extensions.
1160		1331
1161	=item B<transient-for>: I<windowid>	1332	=item B<transient-for>: I<windowid>
1162		1333
1163	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1334	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164		1335
1165	=item B<override-redirect>: I<boolean>	1336	=item B<override-redirect>: I<boolean>
1166		1337
1167	Compile I<frills>: Sets override-redirect for the terminal window, making	1338	Compile I<frills>: Sets override-redirect for the terminal window, making
1168	it almost invisible to window managers; option B<-override-redirect>.	1339	it almost invisible to window managers; option B<-override-redirect>.
		1340
		1341	=item B<iso14755:> I<boolean>
		1342
		1343	Turn on/off ISO 14755 (default enabled).
		1344
		1345	=item B<iso14755_52:> I<boolean>
		1346
		1347	Turn on/off ISO 14755 5.2 mode (default enabled).
1169		1348
1170	=back	1349	=back
1171		1350
1172	=head1 THE SCROLLBAR	1351	=head1 THE SCROLLBAR
1173		1352
…		…
1192	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1371	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1193	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1372	(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),	1373	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1195	respectively.	1374	respectively.
1196		1375
1197	=head1 TEXT SELECTION AND INSERTION	1376	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1198		1377
1199	The behaviour of text selection and insertion mechanism is similar to	1378	The behaviour of text selection and insertion/pasting mechanism is similar
1200	I<xterm>(1).	1379	to I<xterm>(1).
1201		1380
1202	=over 4	1381	=over 4
1203		1382
1204	=item B<Selection>:	1383	=item B<Selecting>:
1205		1384
1206	Left click at the beginning of the region, drag to the end of the region	1385	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	1386	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	1387	to select a word; Left triple-click to select the entire logical line
1209	(which can span multiple screen lines), unless modified by resource	1388	(which can span multiple screen lines), unless modified by resource
…		…
1213	(Compile: I<frills>) will create a rectangular selection instead of a	1392	(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	1393	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	1394	selection, and trailing whitespace is visually underlined and removed from
1216	the selection.	1395	the selection.
1217		1396
1218	=item B<Insertion>:	1397	=item B<Pasting>:
1219		1398
1220	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1399	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	1400	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.	1401	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1223		1402
1224	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1403	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225	inserted too.	1404	inserted too.
1226		1405
1227	=back	1406	=back
…		…
1244		1423
1245	=head1 ISO 14755 SUPPORT	1424	=head1 ISO 14755 SUPPORT
1246		1425
1247	ISO 14755 is a standard for entering and viewing unicode characters	1426	ISO 14755 is a standard for entering and viewing unicode characters
1248	and character codes using the keyboard. It consists of 4 parts. The	1427	and character codes using the keyboard. It consists of 4 parts. The
1249	first part is available rxvt-unicode has been compiled with	1428	first part is available if rxvt-unicode has been compiled with
1250	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1429	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1251	with C<--enable-iso14755>.	1430	with C<--enable-iso14755>.
1252		1431
1253	=over 4	1432	=over 4
1254		1433
…		…
1312	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1491	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	1492	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	1493	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.	1494	on some systems or setgid to root or to some other group on others.
1316		1495
1317	=head1 COLORS AND GRAPHICS	1496	=head1 COLOURS AND GRAPHICS
1318		1497
1319	In addition to the default foreground and background colours,	1498	In addition to the default foreground and background colours,
1320	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1499	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	1500	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1322	colours with their names.	1501	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1502	cube plus a 8 (24) colour greyscale ramp.
		1503
		1504	Here is a list of the ANSI colours with their names.
1323		1505
1324	=begin table	1506	=begin table
1325		1507
1326	B<color0> (black) = Black	1508	B<color0> (black) = Black
1327	B<color1> (red) = Red3	1509	B<color1> (red) = Red3
…		…
1347	It is also possible to specify the colour values of B<foreground>,	1529	It is also possible to specify the colour values of B<foreground>,
1348	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1530	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	1531	a number 0-15, as a convenient shorthand to reference the colour name of
1350	color0-color15.	1532	color0-color15.
1351		1533
1352	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1534	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)	1535	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		1536
		1537	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1538
		1539	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1540	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1541
		1542	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1543	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1544	the RGB cube.
		1545
1357	Together, all those colours implement the 88 colour xterm colours. Only	1546	Together, all those colours implement the 88 (256) colour xterm
1358	the first 16 can be changed using resources currently, the rest can only	1547	colours. Only the first 16 can be changed using resources currently, the
1359	be changed via command sequences ("escape codes").	1548	rest can only be changed via command sequences ("escape codes").
		1549
		1550	Applications are advised to use terminfo or command sequences to discover
		1551	number and RGB values of all colours (yes, you can query this...).
1360		1552
1361	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1553	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1362	always swapping the foreground/background colours. This is in contrast to	1554	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	1555	I<xterm>(1) where the colours are only swapped if they have not otherwise
1364	been specified. For example,	1556	been specified. For example,
1365		1557
1366	=over 4
1367
1368	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1558	@@RXVT_NAME@@ -fg Black -bg White -rv
1369		1559
1370	would yield White on Black, while on I<xterm>(1) it would yield Black	1560	would yield White on Black, while on I<xterm>(1) it would yield Black on
1371	on White.	1561	White.
1372
1373	=back
1374		1562
1375	=head2 ALPHA CHANNEL SUPPORT	1563	=head2 ALPHA CHANNEL SUPPORT
1376		1564
1377	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1565	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>	1566	their act together, rxvt-unicode will do its own alpha channel management:
1379	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1567
1380	in addition to the ones provided by X, where the additional A component	1568	You can prefix any colour with an opaqueness percentage enclosed in
		1569	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1570	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1571	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1572	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1573	is the recommended format to specify transparency values, and works with
		1574	all ways to specify a colour.
		1575
		1576	For complete control, rxvt-unicode also supports
		1577	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1578	specifications, where the additional C<aaaa> component specifies opacity
1381	specifies opacity (alpha) values. The minimum value of C<0> is completely	1579	(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	1580	while C<ffff> is completely opaque). The two example colours from
1383	to four hex digits specifiying the opacity value.	1581	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1582	C<rgba:0000/ff00/0000/f332>.
1384		1583
1385	You probably need to specify B<"-depth 32">, too, and have the luck that	1584	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	1585	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.	1586	layout, as X is far from just supporting ARGB visuals out of the box, and
		1587	rxvt-unicode just fudges around.
1388		1588
1389	For example, the following selects an almost completely transparent red	1589	For example, the following selects an almost completely transparent black
1390	background, and an almost opaque pink foreground:	1590	background, and an almost opaque pink foreground:
1391		1591
1392	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"	1592	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1393		1593
1394	I<Please note that transparency of any kind if completely unsupported by	1594	When not using a background image, then the interpretation of the
1395	the author. Don't bug him with installation questions!>	1595	alpha channel is up to your compositing manager (most interpret it as
		1596	transparency of course).
		1597
		1598	When using a background pixmap or pseudo-transparency, then the background
		1599	colour will always behave as if it were completely transparent (so the
		1600	background image shows instead), regardless of how it was specified, while
		1601	other colours will either be transparent as specified (the background
		1602	image will show through) on servers supporting the RENDER extension, or
		1603	fully opaque on servers not supporting the RENDER EXTENSION.
		1604
		1605	Please note that due to bugs in Xft, specifying alpha values might result
		1606	in garbage being displayed when the X-server does not support the RENDER
		1607	extension.
1396		1608
1397	=head1 ENVIRONMENT	1609	=head1 ENVIRONMENT
1398		1610
1399	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1611	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1400		1612
…		…
1406	resources or on the command line.	1618	resources or on the command line.
1407		1619
1408	=item B<COLORTERM>	1620	=item B<COLORTERM>
1409		1621
1410	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1622	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1411	compiled with XPM support, and optionally with the added extension	1623	compiled with background image support, and optionally with the added
1412	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1624	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1625	screen.
1413		1626
1414	=item B<COLORFGBG>	1627	=item B<COLORFGBG>
1415		1628
1416	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1629	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	1630	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	1631	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	1632	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@@	1633	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	1634	was compiled with background image support. Libraries like C<ncurses>
1422	(and do) use this information to optimize screen output.	1635	and C<slang> can (and do) use this information to optimize screen output.
1423		1636
1424	=item B<WINDOWID>	1637	=item B<WINDOWID>
1425		1638
1426	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1639	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	1640	window, which usually has subwindows for the scrollbar, the terminal
…		…
1433	C<--with-terminfo=PATH>.	1646	C<--with-terminfo=PATH>.
1434		1647
1435	=item B<DISPLAY>	1648	=item B<DISPLAY>
1436		1649
1437	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1650	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1438	display in its child processes.	1651	display in its child processes if C<-display> isn't used to override. It
		1652	defaults to C<:0> if it doesn't exist.
1439		1653
1440	=item B<SHELL>	1654	=item B<SHELL>
1441		1655
1442	The shell to be used for command execution, defaults to C</bin/sh>.	1656	The shell to be used for command execution, defaults to C</bin/sh>.
1443		1657
1444	=item B<RXVT_SOCKET>	1658	=item B<RXVT_SOCKET>
1445		1659
1446	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1660	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1447	@@RXVT_NAME@@d(1).	1661	@@RXVT_NAME@@d(1).
1448		1662
1449	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1663	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1450		1664
1451	=item B<HOME>	1665	=item B<HOME>
1452		1666
1453	Used to locate the default directory for the unix domain socket for	1667	Used to locate the default directory for the unix domain socket for
1454	daemon communications and to locate various resource files (such as	1668	daemon communications and to locate various resource files (such as
1455	C<.Xdefaults>)	1669	C<.Xdefaults>)
1456		1670
1457	=item B<XAPPLRESDIR>	1671	=item B<XAPPLRESDIR>
1458		1672
1459	Directory where various X resource files are being located.	1673	Directory where application-specific X resource files are located.
1460		1674
1461	=item B<XENVIRONMENT>	1675	=item B<XENVIRONMENT>
1462		1676
1463	If set and accessible, gives the name of a X resource file to be loaded by	1677	If set and accessible, gives the name of a X resource file to be loaded by
1464	@@RXVT_NAME@@.	1678	@@RXVT_NAME@@.
…		…
1469		1683
1470	=over 4	1684	=over 4
1471		1685
1472	=item B</usr/lib/X11/rgb.txt>	1686	=item B</usr/lib/X11/rgb.txt>
1473		1687
1474	Color names.	1688	Colour names.
1475		1689
1476	=back	1690	=back
1477		1691
1478	=head1 SEE ALSO	1692	=head1 SEE ALSO
1479		1693
…		…
1518	Project Coordinator (changes.txt 2.21a to 2.4.5)	1732	Project Coordinator (changes.txt 2.21a to 2.4.5)
1519		1733
1520	=item Geoff Wing L<< <gcw@pobox.com> >>	1734	=item Geoff Wing L<< <gcw@pobox.com> >>
1521		1735
1522	Rewrote screen display and text selection routines.	1736	Rewrote screen display and text selection routines.
1523		1737
1524	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1738	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1525		1739
1526	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1740	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1527		1741
1528	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1742	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1530		1744
1531	Project Coordinator (Changes 1.0 -)	1745	Project Coordinator (Changes 1.0 -)
1532		1746
1533	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1534		1748
1535	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1749	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1536		1750
1537	=back	1751	=back
1538		1752

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.212 by sf-exg, Sun Jan 1 14:31:28 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.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC