[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.219 by root, Thu Jun 7 16:06:23 2012 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<frills>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
102		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
		114	visual ids).
		115
103	=item B<-geometry> I<geom>	116	=item B<-geometry> I<geom>
104		117
105	Window geometry (B<-g> still respected); resource B<geometry>.	118	Window geometry (B<-g> still respected); resource B<geometry>.
106		119
107	=item B<-rv>\|B<+rv>	120	=item B<-rv>\|B<+rv>
108		121
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	122	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		123
111	=item B<-j>\|B<+j>	124	=item B<-j>\|B<+j>
112		125
113	Turn on/off jump scrolling; resource B<jumpScroll>.	126	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		127
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	128	=item B<-ss>\|B<+ss>
116		129
117	Turn on/off inheriting parent window's pixmap. Alternative form is	130	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		131
120	I<Please note that transparency of any kind if completely unsupported by	132	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions! Read the FAQ (man 7	133
122	@@RXVT_NAME@@)!>	134	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
		135
		136	B<-ip> is still accepted as an obsolete alias but will be removed in
		137	future versions.
123		138
124	=item B<-fade> I<number>	139	=item B<-fade> I<number>
125		140
126	Fade the text by the given percentage when focus is lost. Small values	141	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	142	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	147	Fade to this colour when fading is used (see B<-fade>). The default colour
133	is opaque black. resource B<fadeColor>.	148	is opaque black. resource B<fadeColor>.
134		149
135	=item B<-tint> I<colour>	150	=item B<-tint> I<colour>
136		151
137	Tint the transparent background pixmap with the given colour when	152	Tint the transparent background with the given colour;
138	transparency is enabled with B<-tr> or B<-ip>. This only works for	153	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		154
143	@@RXVT_NAME@@ -tr -tint blue -sh 40	155	=item B<-sh> I<number>
144		156
145	=item B<-sh>
146
147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	157	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
148	background image in addition to tinting it (i.e. B<-tint> must be	158	A value of 100 means no shading; resource I<shading>.
149	specified, too, e.g. C<-tint white>).	159
		160	=item B<-blr> I<HxV>
		161
		162	Apply Gaussian Blur with the specified radii to the transparent
		163	background. If a single number is specified, the vertical and
		164	horizontal radii are considered to be the same. Setting one of the
		165	radii to 1 and the other to a large number creates interesting effects
		166	on some backgrounds. The maximum radius value is 128. An horizontal or
		167	vertical radius of 0 disables blurring;
		168	resource I<blurRadius>.
		169
		170	=item B<-icon> I<file>
		171
		172	Compile I<pixbuf>: Use the specified image as application icon. This
		173	is used by many window managers, taskbars and pagers to represent the
		174	application window; resource I<iconFile>.
150		175
151	=item B<-bg> I<colour>	176	=item B<-bg> I<colour>
152		177
153	Window background colour; resource B<background>.	178	Window background colour; resource B<background>.
154		179
155	=item B<-fg> I<colour>	180	=item B<-fg> I<colour>
156		181
157	Window foreground colour; resource B<foreground>.	182	Window foreground colour; resource B<foreground>.
158		183
159	=item B<-pixmap> I<file[;geom]>	184	=item B<-pixmap> I<file[;oplist]>
160		185
161	Compile I<XPM>: Specify XPM file for the background and also optionally	186	Compile I<pixbuf>: Specify image file for the background and also
162	specify its scaling with a geometry string. Note you may need to	187	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	188	add quotes to avoid special shell interpretation of the C<;> in the
164	command-line; resource B<backgroundPixmap>.	189	command-line; for more details see resource B<backgroundPixmap>.
165		190
166	=item B<-cr> I<colour>	191	=item B<-cr> I<colour>
167		192
168	The cursor colour; resource B<cursorColor>.	193	The cursor colour; resource B<cursorColor>.
169		194
…		…
214	italic> >> characters are to be printed. See resource B<boldItalicFont>	239	italic> >> characters are to be printed. See resource B<boldItalicFont>
215	for details.	240	for details.
216		241
217	=item B<-is>\|B<+is>	242	=item B<-is>\|B<+is>
218		243
219	Compile I<font-styles>: Bold/Italic font styles imply high intensity	244	Compile I<font-styles>: Bold/Blink font styles imply high intensity
220	foreground/background (default). See resource B<intensityStyles> for	245	foreground/background (default). See resource B<intensityStyles> for
221	details.	246	details.
222		247
223	=item B<-name> I<name>	248	=item B<-name> I<name>
224		249
…		…
242		267
243	=item B<-sb>\|B<+sb>	268	=item B<-sb>\|B<+sb>
244		269
245	Turn on/off scrollbar; resource B<scrollBar>.	270	Turn on/off scrollbar; resource B<scrollBar>.
246		271
		272	=item B<-sr>\|B<+sr>
		273
		274	Put scrollbar on right/left; resource B<scrollBar_right>.
		275
		276	=item B<-st>\|B<+st>
		277
		278	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		279	resource B<scrollBar_floating>.
		280
247	=item B<-si>\|B<+si>	281	=item B<-si>\|B<+si>
248		282
249	Turn on/off scroll-to-bottom on TTY output inhibit; resource	283	Turn on/off scroll-to-bottom on TTY output inhibit; resource
250	B<scrollTtyOutput> has opposite effect.	284	B<scrollTtyOutput> has opposite effect.
251		285
…		…
257	=item B<-sw>\|B<+sw>	291	=item B<-sw>\|B<+sw>
258		292
259	Turn on/off scrolling with the scrollback buffer as new lines appear.	293	Turn on/off scrolling with the scrollback buffer as new lines appear.
260	This only takes effect if B<-si> is also given; resource	294	This only takes effect if B<-si> is also given; resource
261	B<scrollWithBuffer>.	295	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		296
272	=item B<-ptab>\|B<+ptab>	297	=item B<-ptab>\|B<+ptab>
273		298
274	If enabled (default), "Horizontal Tab" characters are being stored as	299	If enabled (default), "Horizontal Tab" characters are being stored as
275	actual wide characters in the screen buffer, which makes it possible to	300	actual wide characters in the screen buffer, which makes it possible to
…		…
279		304
280	=item B<-bc>\|B<+bc>	305	=item B<-bc>\|B<+bc>
281		306
282	Blink the cursor; resource B<cursorBlink>.	307	Blink the cursor; resource B<cursorBlink>.
283		308
		309	=item B<-uc>\|B<+uc>
		310
		311	Make the cursor underlined; resource B<cursorUnderline>.
		312
284	=item B<-iconic>	313	=item B<-iconic>
285		314
286	Start iconified, if the window manager supports that option.	315	Start iconified, if the window manager supports that option.
287	Alternative form is B<-ic>.	316	Alternative form is B<-ic>.
288		317
…		…
304		333
305	=item B<-bl>	334	=item B<-bl>
306		335
307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	336	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	337	if honoured by the WM, the rxvt-unicode window will not have window
309	decorations; resource B<borderLess>.	338	decorations; resource B<borderLess>. If the window manager does not
		339	support MWM hints (e.g. kwin), enables override-redirect mode.
310		340
311	=item B<-override-redirect>	341	=item B<-override-redirect>
312		342
313	Compile I<frills>: Sets override-redirect on the window; resource	343	Compile I<frills>: Sets override-redirect on the window; resource
314	B<override-redirect>.	344	B<override-redirect>.
…		…
322		352
323	=item B<-lsp> I<number>	353	=item B<-lsp> I<number>
324		354
325	Compile I<frills>: Lines (pixel height) to insert between each row of	355	Compile I<frills>: Lines (pixel height) to insert between each row of
326	the display. Useful to work around font rendering problems; resource	356	the display. Useful to work around font rendering problems; resource
327	B<linespace>.	357	B<lineSpace>.
		358
		359	=item B<-letsp> I<number>
		360
		361	Compile I<frills>: Amount to adjust the computed character width by
		362	to control overall letter spacing. Negative values will tighten up the
		363	letter spacing, positive values will space letters out more. Useful to
		364	work around odd font metrics; resource B<letterSpace>.
328		365
329	=item B<-tn> I<termname>	366	=item B<-tn> I<termname>
330		367
331	This option specifies the name of the terminal type to be set in the	368	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	369	B<TERM> environment variable. This terminal type must exist in the
…		…
386	for more info.	423	for more info.
387		424
388	=item B<-tcw>	425	=item B<-tcw>
389		426
390	Change the meaning of triple-click selection with the left mouse	427	Change the meaning of triple-click selection with the left mouse
		428	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	429	in-use. Instead of selecting a full line it will extend the selection to
392	end of the logical line only. resource B<tripleclickwords>.	430	the end of the logical line only. resource B<tripleclickwords>.
393		431
394	=item B<-insecure>	432	=item B<-insecure>
395		433
396	Enable "insecure" mode, which currently enables most of the escape	434	Enable "insecure" mode, which currently enables most of the escape
397	sequences that echo strings. See the resource B<insecure> for more	435	sequences that echo strings. See the resource B<insecure> for more
…		…
417		455
418	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	456	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419	will not immediately destroy its window when the program executed within	457	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	458	it exits. Instead, it will wait till it is being killed or closed by the
421	user; resource B<hold>.	459	user; resource B<hold>.
		460
		461	=item B<-cd> I<path>
		462
		463	Sets the working directory for the shell (or the command specified via
		464	B<-e>). The I<path> must be an absolute path and it must exist for
		465	@@RXVT_NAME@@ to start; resource B<chdir>.
		466
		467	=item B<-xrm> I<string>
		468
		469	Works like the X Toolkit option of the same name, by adding the I<string>
		470	as if it were specified in a resource file. Resource values specified this
		471	way take precedence over all other resource specifications.
		472
		473	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		474	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		475	options can be specified as long-options on the commandline, so use
		476	of B<-xrm> is mostly limited to cases where you want to specify other
		477	resources (e.g. for input methods) or for compatibility with other
		478	programs.
422		479
423	=item B<-keysym.>I<sym> I<string>	480	=item B<-keysym.>I<sym> I<string>
424		481
425	Remap a key symbol. See resource B<keysym>.	482	Remap a key symbol. See resource B<keysym>.
426		483
…		…
461	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	518	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	519	entries and will not tinker with pty/tty permissions - you have to do that
463	yourself if you want that.	520	yourself if you want that.
464		521
465	As an extremely special case, specifying C<-1> will completely suppress	522	As an extremely special case, specifying C<-1> will completely suppress
466	pty/tty operations.	523	pty/tty operations, which is probably only useful in conjunction with some
		524	perl extension that manages the terminal.
467		525
468	Here is a example in perl that illustrates how this option can be used (a	526	Here is a example in perl that illustrates how this option can be used (a
469	longer example is in F<doc/pty-fd>):	527	longer example is in F<doc/pty-fd>):
470		528
471	use IO::Pty;	529	use IO::Pty;
…		…
485	Comma-separated list of perl extension scripts to use (or not to use) in	543	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.	544	this terminal instance. See resource B<perl-ext> for details.
487		545
488	=back	546	=back
489		547
490	=head1 RESOURCES (available also as long-options)	548	=head1 RESOURCES
491		549
492	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	550	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493	options) compiled into your version.	551	options) compiled into your version. All resources are also available as
		552	long-options.
494		553
495	You can set and change the resources using X11 tools like B<xrdb>. Many	554	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	555	distribution do also load settings from the B<~/.Xresources> file when X
497	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	556	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498	with later settings overwriting earlier ones:	557	with later settings overwriting earlier ones:
499		558
500	1. system-wide app-defaults file, either locale-dependent OR global
501	2. app-defaults file in $XAPPLRESDIR	559	1. app-defaults file in $XAPPLRESDIR
		560	2. $HOME/.Xdefaults
502	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	561	3. RESOURCE_MANAGER property on root-window of screen 0
503	4. SCREEN_RESOURCES for the current screen	562	4. SCREEN_RESOURCES property on root-window of the current screen
504	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	563	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		564	6. resources specified via -xrm on the commandline
505		565
506	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	566	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	567	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	568	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	569	configured, while the class name B<URxvt> allows resources unique to
…		…
519	=item B<depth:> I<bitdepth>	579	=item B<depth:> I<bitdepth>
520		580
521	Compile I<xft>: Attempt to find a visual with the given bit depth;	581	Compile I<xft>: Attempt to find a visual with the given bit depth;
522	option B<-depth>.	582	option B<-depth>.
523		583
		584	=item B<buffered:> I<boolean>
		585
		586	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		587	On some card/driver combination enabling it slightly decreases
		588	performance, on most it greatly helps it. The slowdown is small, so it
		589	should normally be enabled.
		590
524	=item B<geometry:> I<geom>	591	=item B<geometry:> I<geom>
525		592
526	Create the window with the specified X window geometry [default 80x24];	593	Create the window with the specified X window geometry [default 80x24];
527	option B<-geometry>.	594	option B<-geometry>.
528		595
…		…
541	Use the specified colour for the colour value I<n>, where 0-7	608	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	609	corresponds to low-intensity (normal) colours and 8-15 corresponds to
543	high-intensity (bold = bright foreground, blink = bright background)	610	high-intensity (bold = bright foreground, blink = bright background)
544	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	611	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	612	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.	613	names used are listed in the B<COLOURS AND GRAPHICS> section.
547		614
548	Colours higher than 15 cannot be set using resources (yet), but can be	615	Colours higher than 15 cannot be set using resources (yet), but can be
549	changed using an escape command (see @@RXVT_NAME@@(7)).	616	changed using an escape command (see @@RXVT_NAME@@(7)).
550		617
551	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	618	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
562	=item B<colorUL:> I<colour>	629	=item B<colorUL:> I<colour>
563		630
564	Use the specified colour to display underlined characters when the	631	Use the specified colour to display underlined characters when the
565	foreground colour is the default.	632	foreground colour is the default.
566		633
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>	634	=item B<underlineColor:> I<colour>
573		635
574	If set, use the specified colour as the colour for the underline	636	If set, use the specified colour as the colour for the underline
575	itself. If unset, use the foreground colour.	637	itself. If unset, use the foreground colour.
		638
		639	=item B<highlightColor:> I<colour>
		640
		641	If set, use the specified colour as the background for highlighted
		642	characters. If unset, use reverse video.
		643
		644	=item B<highlightTextColor:> I<colour>
		645
		646	If set and highlightColor is set, use the specified colour as the
		647	foreground for highlighted characters.
576		648
577	=item B<cursorColor:> I<colour>	649	=item B<cursorColor:> I<colour>
578		650
579	Use the specified colour for the cursor. The default is to use the	651	Use the specified colour for the cursor. The default is to use the
580	foreground colour; option B<-cr>.	652	foreground colour; option B<-cr>.
…		…
587		659
588	=item B<reverseVideo:> I<boolean>	660	=item B<reverseVideo:> I<boolean>
589		661
590	B<True>: simulate reverse video by foreground and background colours;	662	B<True>: simulate reverse video by foreground and background colours;
591	option B<-rv>. B<False>: regular screen colours [default]; option	663	option B<-rv>. B<False>: regular screen colours [default]; option
592	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	664	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593		665
594	=item B<jumpScroll:> I<boolean>	666	=item B<jumpScroll:> I<boolean>
595		667
596	B<True>: specify that jump scrolling should be used. When scrolling	668	B<True>: specify that jump scrolling should be used. When receiving lots
597	quickly, fewer screen updates are performed [default]; option B<-j>.	669	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		670	has been read, resulting in fewer updates while still displaying every
		671	received line; option B<-j>.
		672
598	B<False>: specify that smooth scrolling should be used; option B<+j>.	673	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		674	force a screen refresh on each new line it received; option B<+j>.
599		675
600	=item B<inheritPixmap:> I<boolean>	676	=item B<skipScroll:> I<boolean>
601		677
602	B<True>: make the background inherit the parent windows' pixmap, giving	678	B<True>: (the default) specify that skip scrolling should be used. When
603	artificial transparency. B<False>: do not inherit the parent windows'	679	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604	pixmap.	680	(around 60 times per second), resulting in far fewer updates. This can
		681	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		682	option B<-ss>.
605		683
606	I<Please note that transparency of any kind if completely unsupported by	684	B<False>: specify that everything is to be displayed, even
607	the author. Don't bug him with installation questions!>	685	if the refresh is too fast for the human eye to read anything (or the
		686	monitor to display anything); option B<+ss>.
		687
		688	=item B<transparent:> I<boolean>
		689
		690	Turn on/off pseudo-transparency by using the root pixmap as background.
		691
		692	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		693	future versions.
608		694
609	=item B<fading:> I<number>	695	=item B<fading:> I<number>
610		696
611	Fade the text by the given percentage when focus is lost; option B<-fade>.	697	Fade the text by the given percentage when focus is lost; option B<-fade>.
612		698
…		…
615	Fade to this colour, when fading is used (see B<fading:>). The default	701	Fade to this colour, when fading is used (see B<fading:>). The default
616	colour is black; option B<-fadecolor>.	702	colour is black; option B<-fadecolor>.
617		703
618	=item B<tintColor:> I<colour>	704	=item B<tintColor:> I<colour>
619		705
620	Tint the transparent background pixmap with the given colour; option	706	Tint the transparent background with the given colour. If the RENDER
621	B<-tint>.	707	extension is not available only black, red, green, yellow, blue,
		708	magenta, cyan and white tints can be performed server-side. Note that
		709	a black tint yields a completely black image while a white tint yields
		710	the image unchanged; option B<-tint>.
622		711
623	=item B<shading:> I<number>	712	=item B<shading:> I<number>
624		713
625	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	714	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
626	image in addition to tinting it.	715	A value of 100 means no shading; option B<-sh>.
		716
		717	=item B<blurRadius:> I<number>
		718
		719	Apply gaussian blur with the specified radius to the transparent
		720	background; option B<-blr>.
		721
		722	=item B<iconFile:> I<file>
		723
		724	Set the application icon pixmap; option B<-icon>.
627		725
628	=item B<scrollColor:> I<colour>	726	=item B<scrollColor:> I<colour>
629		727
630	Use the specified colour for the scrollbar [default #B2B2B2].	728	Use the specified colour for the scrollbar [default #B2B2B2].
631		729
…		…
637	=item B<borderColor:> I<colour>	735	=item B<borderColor:> I<colour>
638		736
639	The colour of the border around the text area and between the scrollbar	737	The colour of the border around the text area and between the scrollbar
640	and the text.	738	and the text.
641		739
642	=item B<backgroundPixmap:> I<file[;geom]>	740	=item B<backgroundPixmap:> I<file[;oplist]>
643		741
644	Use the specified XPM file (note the `.xpm' extension is optional) for	742	Use the specified image file for the background and also
645	the background and also optionally specify its scaling with a geometry	743	optionally specify a colon separated list of operations to modify it.
646	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	744	Supported operations are:
647	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	745
648	centre (percent). A scale of 0 displays the image with tiling. A scale	746	=over 4
649	of 1 displays the image without any scaling. A scale of 2 to 9	747
650	specifies an integer number of images in that direction. No image will	748	=item B<WxH+X+Y>
651	be magnified beyond 10 times its original size. The maximum permitted	749
652	scale is 1000. [default 0x0+50+50]	750	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		751	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		752	scale of 0 disables scaling.
		753
		754	=item B<op=tile>
		755
		756	enables tiling
		757
		758	=item B<op=keep-aspect>
		759
		760	maintain the image aspect ratio when scaling
		761
		762	=item B<op=root-align>
		763
		764	use the position of the terminal window relative to the root window as
		765	the image offset, simulating a root window background
		766
		767	=back
		768
		769	The default scale and position setting is C<100x100+50+50>.
		770	Alternatively, a predefined set of templates can be used to achieve
		771	the most common setups:
		772
		773	=over 4
		774
		775	=item B<style=tiled>
		776
		777	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		778
		779	=item B<style=aspect-stretched>
		780
		781	the image is scaled to fill the whole window maintaining the aspect
		782	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		783
		784	=item B<style=stretched>
		785
		786	the image is scaled to fill the whole window. Equivalent to 100x100
		787
		788	=item B<style=centered>
		789
		790	the image is centered with no scaling. Equivalent to 0x0+50+50
		791
		792	=item B<style=root-tiled>
		793
		794	the image is tiled with no scaling and using 'root' positioning.
		795	Equivalent to 0x0:op=tile:op=root-align
		796
		797	=back
		798
		799	If multiple templates are specified the last one wins. Note that a
		800	template overrides all the scale, position and operations settings.
		801
		802	If used in conjunction with B<-tr> option, the specified pixmap will be
		803	blended over the transparent background using alpha-blending.
653		804
654	=item B<path:> I<path>	805	=item B<path:> I<path>
655		806
656	Specify the colon-delimited search path for finding XPM files.	807	Specify the colon-delimited search path for finding background image files.
657		808
658	=item B<font:> I<fontlist>	809	=item B<font:> I<fontlist>
659		810
660	Select the fonts to be used. This is a comma separated list of font names	811	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	812	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	835	it is named first) and thus defines the character cell grid to be 9 pixels
685	wide and 15 pixels high.	836	wide and 15 pixels high.
686		837
687	The second font is just used to add additional unicode characters not in	838	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	839	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	840	the bold version of the font does contain fewer characters, so this is a
690	useful supplement.	841	useful supplement.
691		842
692	The third font is an Xft font with aliasing turned off, and the characters	843	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	844	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.	845	contains other characters, but we are not interested in them.
…		…
718	text font will being used for the given style.	869	text font will being used for the given style.
719		870
720	=item B<intensityStyles:> I<boolean>	871	=item B<intensityStyles:> I<boolean>
721		872
722	When font styles are not enabled, or this option is enabled (B<True>,	873	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	874	option B<-is>, the default), bold/blink font styles imply high
724	intensity foreground/background colours. Disabling this option (B<False>,	875	intensity foreground/background colours. Disabling this option (B<False>,
725	option B<+is>) disables this behaviour, the high intensity colours are not	876	option B<+is>) disables this behaviour, the high intensity colours are not
726	reachable.	877	reachable.
727		878
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>	879	=item B<title:> I<string>
740		880
741	Set window title string, the default title is the command-line	881	Set window title string, the default title is the command-line
742	specified after the B<-e> option, if any, otherwise the application	882	specified after the B<-e> option, if any, otherwise the application
743	name; option B<-title>.	883	name; option B<-title>.
…		…
751	=item B<mapAlert:> I<boolean>	891	=item B<mapAlert:> I<boolean>
752		892
753	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	893	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].	894	de-iconify (map) on receipt of a bell character [default].
755		895
		896	=item B<urgentOnBell:> I<boolean>
		897
		898	B<True>: set the urgency hint for the wm on receipt of a bell character.
		899	B<False>: do not set the urgency hint [default].
		900
		901	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		902
756	=item B<visualBell:> I<boolean>	903	=item B<visualBell:> I<boolean>
757		904
758	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	905	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759	B<False>: no visual bell [default]; option B<+vb>.	906	B<False>: no visual bell [default]; option B<+vb>.
760		907
…		…
783	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	930	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784		931
785	This creates a new file in your home directory with the screen contents	932	This creates a new file in your home directory with the screen contents
786	every time you hit C<Print>.	933	every time you hit C<Print>.
787		934
		935	=item B<scrollstyle:> I<mode>
		936
		937	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		938	the author's favourite.
		939
		940	=item B<thickness:> I<number>
		941
		942	Set the scrollbar width in pixels.
		943
788	=item B<scrollBar:> I<boolean>	944	=item B<scrollBar:> I<boolean>
789		945
790	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	946	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791	disable the scrollbar; option B<+sb>.	947	disable the scrollbar; option B<+sb>.
792		948
…		…
811	B<False>: do not scroll to bottom when tty receives output; option	967	B<False>: do not scroll to bottom when tty receives output; option
812	B<+si>.	968	B<+si>.
813		969
814	=item B<scrollWithBuffer:> I<boolean>	970	=item B<scrollWithBuffer:> I<boolean>
815		971
816	B<True>: scroll with scrollback buffer when tty receives new lines (and	972	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	973	try to show the same lines) and B<scrollTtyOutput> is False; option
818	with scrollback buffer when tty receives new lines; option B<+sw>.	974	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		975	new lines; option B<+sw>.
819		976
820	=item B<scrollTtyKeypress:> I<boolean>	977	=item B<scrollTtyKeypress:> I<boolean>
821		978
822	B<True>: scroll to bottom when a non-special key is pressed. Special keys	979	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	980	are those which are intercepted by rxvt-unicode for special handling and
…		…
854	=item B<termName:> I<termname>	1011	=item B<termName:> I<termname>
855		1012
856	Specifies the terminal type name to be set in the B<TERM> environment	1013	Specifies the terminal type name to be set in the B<TERM> environment
857	variable; option B<-tn>.	1014	variable; option B<-tn>.
858		1015
859	=item B<linespace:> I<number>	1016	=item B<lineSpace:> I<number>
860		1017
861	Specifies number of lines (pixel height) to insert between each row of	1018	Specifies number of lines (pixel height) to insert between each row of
862	the display [default 0]; option B<-lsp>.	1019	the display [default 0]; option B<-lsp>.
863		1020
864	=item B<meta8:> I<boolean>	1021	=item B<meta8:> I<boolean>
…		…
878		1035
879	=item B<cursorBlink:> I<boolean>	1036	=item B<cursorBlink:> I<boolean>
880		1037
881	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1038	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
882	option B<-bc>.	1039	option B<-bc>.
		1040
		1041	=item B<cursorUnderline:> I<boolean>
		1042
		1043	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1044	option B<-uc>.
883		1045
884	=item B<pointerBlank:> I<boolean>	1046	=item B<pointerBlank:> I<boolean>
885		1047
886	B<True>: blank the pointer when a key is pressed or after a set number	1048	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	1049	of seconds of inactivity. B<False>: the pointer is always visible
…		…
901	large number (e.g. C<987654321>) to effectively disable the timeout.	1063	large number (e.g. C<987654321>) to effectively disable the timeout.
902		1064
903	=item B<backspacekey:> I<string>	1065	=item B<backspacekey:> I<string>
904		1066
905	The string to send when the backspace key is pressed. If set to B<DEC>	1067	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>	1068	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	1069	(code 8) - which can be reversed with the appropriate DEC private mode
908	escape sequence.	1070	escape sequence.
909		1071
910	=item B<deletekey:> I<string>	1072	=item B<deletekey:> I<string>
911		1073
…		…
916	=item B<cutchars:> I<string>	1078	=item B<cutchars:> I<string>
917		1079
918	The characters used as delimiters for double-click word selection	1080	The characters used as delimiters for double-click word selection
919	(whitespace delimiting is added automatically if resource is given).	1081	(whitespace delimiting is added automatically if resource is given).
920		1082
921	When the selection extension is in use (the default if compiled in, see	1083	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	1084	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	1085	characters will be created (if the resource exists, otherwise, no regex
924	created). In this mode, characters outside ISO-8859-1 can be used.	1086	will be created). In this mode, characters outside ISO-8859-1 can be used.
925		1087
926	When the selection extension is not used, only ISO-8859-1 characters can	1088	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:	1089	be used. If not specified, the built-in default is used:
928		1090
929	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1091	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
930		1092
931	=item B<preeditType:> I<style>	1093	=item B<preeditType:> I<style>
932		1094
933	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1095	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934		1096
…		…
988		1150
989	Turn on/off secondary screen (default enabled).	1151	Turn on/off secondary screen (default enabled).
990		1152
991	=item B<secondaryScroll:> I<boolean>	1153	=item B<secondaryScroll:> I<boolean>
992		1154
993	Turn on/off secondary screen scroll (default enabled). If the this	1155	Turn on/off secondary screen scroll (default enabled). If this
994	option is enabled, scrolls on the secondary screen will change the	1156	option is enabled, scrolls on the secondary screen will change the
995	scrollback buffer and switching to/from the secondary screen will	1157	scrollback buffer and, when secondaryScreen is off, switching
996	instead scroll the screen up.	1158	to/from the secondary screen will instead scroll the screen up.
997		1159
998	=item B<hold>: I<boolean>	1160	=item B<hold>: I<boolean>
999		1161
1000	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1162	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001	will not immediately destroy its window when the program executed within	1163	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	1164	it exits. Instead, it will wait till it is being killed or closed by the
1003	user.	1165	user.
		1166
		1167	=item B<chdir>: I<path>
		1168
		1169	Sets the working directory for the shell (or the command specified via
		1170	B<-e>). The I<path> must be an absolute path and it must exist for
		1171	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1172	directory will be used; option B<-cd>.
1004		1173
1005	=item B<keysym.>I<sym>: I<string>	1174	=item B<keysym.>I<sym>: I<string>
1006		1175
1007	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1176	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1008	intervening resource name B<keysym.> cannot be omitted.	1177	intervening resource name B<keysym.> cannot be omitted.
…		…
1022	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1191	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	1192	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	1193	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.	1194	performed in an exact manner; however, the closest match is assured.
1026		1195
1027	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1196	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,	1197	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		1198
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>	1199	You can define a range of keysyms in one shot by
		1200	loading the C<keysym-list> perl extension and providing a I<string>
1039	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1201	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1040	should be a character not used by the strings.	1202	should be a character not used by the strings.
1041		1203
1042	Its usage can be demonstrated by an example:	1204	Its usage can be demonstrated by an example:
1043		1205
1044	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1206	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1045		1207
1046	The above line is equivalent to the following three lines:	1208	The above line is equivalent to the following three lines:
1047		1209
1048	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1210	URxvt.keysym.Meta-Control-0x61: \033<a>
1049	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1211	URxvt.keysym.Meta-Control-0x62: \033<b>
1050	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1212	URxvt.keysym.Meta-Control-0x63: \033<c>
1051		1213
1052	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1214	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	1215	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>	1216	example the following means "change the current locale to C<zh_CN.GBK>
1055	when Control-Meta-c is being pressed":	1217	when Control-Meta-c is being pressed":
1056		1218
1057	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1219	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1058		1220
1059	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1221	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)	1222	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	1223	manpage. For example, the F<selection> extension (activated via
1062	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1224	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1063		1225
1064	URxvt.keysym.M-C-c: perl:selection:rot13	1226	URxvt.keysym.M-C-c: perl:selection:rot13
1065		1227
1066	Due the the large number of modifier combinations, a defined key mapping	1228	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	1229	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	1230	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	1231	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	1232	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1071	mappings themselves.	1233	mappings themselves.
1072		1234
…		…
1123	all instances, while B<perl-ext> is used for specific instances.	1285	all instances, while B<perl-ext> is used for specific instances.
1124		1286
1125	=item B<perl-eval>: I<string>	1287	=item B<perl-eval>: I<string>
1126		1288
1127	Perl code to be evaluated when all extensions have been registered. See	1289	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	1290	the @@RXVT_NAME@@perl(3) manpage.
1129	will be ignored when running setuid/setgid.
1130		1291
1131	=item B<perl-lib>: I<path>	1292	=item B<perl-lib>: I<path>
1132		1293
1133	Colon-separated list of additional directories that hold extension	1294	Colon-separated list of additional directories that hold extension
1134	scripts. When looking for extensions specified by the C<perl> resource,	1295	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1135	@@RXVT_NAME@@ will first look in these directories and then in	1296	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1136	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1297	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1137	will be ignored when running setuid/setgid.
1138		1298
1139	See the @@RXVT_NAME@@perl(3) manpage.	1299	See the @@RXVT_NAME@@perl(3) manpage.
1140		1300
1141	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1301	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1142		1302
…		…
1154	(default: C<M-s>).	1314	(default: C<M-s>).
1155		1315
1156	=item B<urlLauncher>: I<string>	1316	=item B<urlLauncher>: I<string>
1157		1317
1158	Specifies the program to be started with a URL argument. Used by the	1318	Specifies the program to be started with a URL argument. Used by the
1159	C<selection-popup> and C<mark-urls> perl extensions.	1319	C<selection-popup> and C<matcher> perl extensions.
1160		1320
1161	=item B<transient-for>: I<windowid>	1321	=item B<transient-for>: I<windowid>
1162		1322
1163	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1323	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164		1324
1165	=item B<override-redirect>: I<boolean>	1325	=item B<override-redirect>: I<boolean>
1166		1326
1167	Compile I<frills>: Sets override-redirect for the terminal window, making	1327	Compile I<frills>: Sets override-redirect for the terminal window, making
1168	it almost invisible to window managers; option B<-override-redirect>.	1328	it almost invisible to window managers; option B<-override-redirect>.
		1329
		1330	=item B<iso14755:> I<boolean>
		1331
		1332	Turn on/off ISO 14755 (default enabled).
		1333
		1334	=item B<iso14755_52:> I<boolean>
		1335
		1336	Turn on/off ISO 14755 5.2 mode (default enabled).
1169		1337
1170	=back	1338	=back
1171		1339
1172	=head1 THE SCROLLBAR	1340	=head1 THE SCROLLBAR
1173		1341
…		…
1192	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1360	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1193	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1361	(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),	1362	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1195	respectively.	1363	respectively.
1196		1364
1197	=head1 TEXT SELECTION AND INSERTION	1365	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1198		1366
1199	The behaviour of text selection and insertion mechanism is similar to	1367	The behaviour of text selection and insertion/pasting mechanism is similar
1200	I<xterm>(1).	1368	to I<xterm>(1).
1201		1369
1202	=over 4	1370	=over 4
1203		1371
1204	=item B<Selection>:	1372	=item B<Selecting>:
1205		1373
1206	Left click at the beginning of the region, drag to the end of the region	1374	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	1375	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	1376	to select a word; Left triple-click to select the entire logical line
1209	(which can span multiple screen lines), unless modified by resource	1377	(which can span multiple screen lines), unless modified by resource
…		…
1213	(Compile: I<frills>) will create a rectangular selection instead of a	1381	(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	1382	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	1383	selection, and trailing whitespace is visually underlined and removed from
1216	the selection.	1384	the selection.
1217		1385
1218	=item B<Insertion>:	1386	=item B<Pasting>:
1219		1387
1220	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1388	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	1389	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.	1390	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1223		1391
1224	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1392	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225	inserted too.	1393	inserted too.
1226		1394
1227	=back	1395	=back
…		…
1244		1412
1245	=head1 ISO 14755 SUPPORT	1413	=head1 ISO 14755 SUPPORT
1246		1414
1247	ISO 14755 is a standard for entering and viewing unicode characters	1415	ISO 14755 is a standard for entering and viewing unicode characters
1248	and character codes using the keyboard. It consists of 4 parts. The	1416	and character codes using the keyboard. It consists of 4 parts. The
1249	first part is available rxvt-unicode has been compiled with	1417	first part is available if rxvt-unicode has been compiled with
1250	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1418	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1251	with C<--enable-iso14755>.	1419	with C<--enable-iso14755>.
1252		1420
1253	=over 4	1421	=over 4
1254		1422
…		…
1312	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1480	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	1481	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	1482	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.	1483	on some systems or setgid to root or to some other group on others.
1316		1484
1317	=head1 COLORS AND GRAPHICS	1485	=head1 COLOURS AND GRAPHICS
1318		1486
1319	In addition to the default foreground and background colours,	1487	In addition to the default foreground and background colours,
1320	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1488	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	1489	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1322	colours with their names.	1490	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1491	cube plus a 8 (24) colour greyscale ramp.
		1492
		1493	Here is a list of the ANSI colours with their names.
1323		1494
1324	=begin table	1495	=begin table
1325		1496
1326	B<color0> (black) = Black	1497	B<color0> (black) = Black
1327	B<color1> (red) = Red3	1498	B<color1> (red) = Red3
…		…
1347	It is also possible to specify the colour values of B<foreground>,	1518	It is also possible to specify the colour values of B<foreground>,
1348	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1519	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	1520	a number 0-15, as a convenient shorthand to reference the colour name of
1350	color0-color15.	1521	color0-color15.
1351		1522
1352	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1523	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)	1524	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		1525
		1526	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1527
		1528	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1529	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1530
		1531	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1532	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1533	the RGB cube.
		1534
1357	Together, all those colours implement the 88 colour xterm colours. Only	1535	Together, all those colours implement the 88 (256) colour xterm
1358	the first 16 can be changed using resources currently, the rest can only	1536	colours. Only the first 16 can be changed using resources currently, the
1359	be changed via command sequences ("escape codes").	1537	rest can only be changed via command sequences ("escape codes").
		1538
		1539	Applications are advised to use terminfo or command sequences to discover
		1540	number and RGB values of all colours (yes, you can query this...).
1360		1541
1361	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1542	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1362	always swapping the foreground/background colours. This is in contrast to	1543	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	1544	I<xterm>(1) where the colours are only swapped if they have not otherwise
1364	been specified. For example,	1545	been specified. For example,
1365		1546
1366	=over 4
1367
1368	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1547	@@RXVT_NAME@@ -fg Black -bg White -rv
1369		1548
1370	would yield White on Black, while on I<xterm>(1) it would yield Black	1549	would yield White on Black, while on I<xterm>(1) it would yield Black on
1371	on White.	1550	White.
1372
1373	=back
1374		1551
1375	=head2 ALPHA CHANNEL SUPPORT	1552	=head2 ALPHA CHANNEL SUPPORT
1376		1553
1377	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1554	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>	1555	their act together, rxvt-unicode will do its own alpha channel management:
1379	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1556
1380	in addition to the ones provided by X, where the additional A component	1557	You can prefix any colour with an opaqueness percentage enclosed in
		1558	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1559	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1560	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1561	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1562	is the recommended format to specify transparency values, and works with
		1563	all ways to specify a colour.
		1564
		1565	For complete control, rxvt-unicode also supports
		1566	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1567	specifications, where the additional C<aaaa> component specifies opacity
1381	specifies opacity (alpha) values. The minimum value of C<0> is completely	1568	(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	1569	while C<ffff> is completely opaque). The two example colours from
1383	to four hex digits specifiying the opacity value.	1570	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1571	C<rgba:0000/ff00/0000/f332>.
1384		1572
1385	You probably need to specify B<"-depth 32">, too, and have the luck that	1573	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	1574	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.	1575	layout, as X is far from just supporting ARGB visuals out of the box, and
		1576	rxvt-unicode just fudges around.
1388		1577
1389	For example, the following selects an almost completely transparent red	1578	For example, the following selects an almost completely transparent black
1390	background, and an almost opaque pink foreground:	1579	background, and an almost opaque pink foreground:
1391		1580
1392	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"	1581	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1393		1582
1394	I<Please note that transparency of any kind if completely unsupported by	1583	When not using a background image, then the interpretation of the
1395	the author. Don't bug him with installation questions!>	1584	alpha channel is up to your compositing manager (most interpret it as
		1585	transparency of course).
		1586
		1587	When using a background pixmap or pseudo-transparency, then the background
		1588	colour will always behave as if it were completely transparent (so the
		1589	background image shows instead), regardless of how it was specified, while
		1590	other colours will either be transparent as specified (the background
		1591	image will show through) on servers supporting the RENDER extension, or
		1592	fully opaque on servers not supporting the RENDER EXTENSION.
		1593
		1594	Please note that due to bugs in Xft, specifying alpha values might result
		1595	in garbage being displayed when the X-server does not support the RENDER
		1596	extension.
1396		1597
1397	=head1 ENVIRONMENT	1598	=head1 ENVIRONMENT
1398		1599
1399	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1600	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1400		1601
…		…
1406	resources or on the command line.	1607	resources or on the command line.
1407		1608
1408	=item B<COLORTERM>	1609	=item B<COLORTERM>
1409		1610
1410	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1611	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1411	compiled with XPM support, and optionally with the added extension	1612	compiled with background image support, and optionally with the added
1412	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1613	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1614	screen.
1413		1615
1414	=item B<COLORFGBG>	1616	=item B<COLORFGBG>
1415		1617
1416	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1618	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	1619	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	1620	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	1621	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@@	1622	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	1623	was compiled with background image support. Libraries like C<ncurses>
1422	(and do) use this information to optimize screen output.	1624	and C<slang> can (and do) use this information to optimize screen output.
1423		1625
1424	=item B<WINDOWID>	1626	=item B<WINDOWID>
1425		1627
1426	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1628	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	1629	window, which usually has subwindows for the scrollbar, the terminal
…		…
1433	C<--with-terminfo=PATH>.	1635	C<--with-terminfo=PATH>.
1434		1636
1435	=item B<DISPLAY>	1637	=item B<DISPLAY>
1436		1638
1437	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1639	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1438	display in its child processes.	1640	display in its child processes if C<-display> isn't used to override. It
		1641	defaults to C<:0> if it doesn't exist.
1439		1642
1440	=item B<SHELL>	1643	=item B<SHELL>
1441		1644
1442	The shell to be used for command execution, defaults to C</bin/sh>.	1645	The shell to be used for command execution, defaults to C</bin/sh>.
1443		1646
1444	=item B<RXVT_SOCKET>	1647	=item B<RXVT_SOCKET> [I<sic>]
1445		1648
1446	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1649	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1447	@@RXVT_NAME@@d(1).	1650	@@RXVT_NAME@@d(1).
1448		1651
1449	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1652	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1653
		1654	=item B<URXVT_PERL_LIB>
		1655
		1656	Additional F<:>-separated library search path for perl extensions. Will be
		1657	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1658	directory.
		1659
		1660	=item B<URXVT_PERL_VERBOSITY>
		1661
		1662	See L<@@RXVT_NAME@@perl>(3).
1450		1663
1451	=item B<HOME>	1664	=item B<HOME>
1452		1665
1453	Used to locate the default directory for the unix domain socket for	1666	Used to locate the default directory for the unix domain socket for
1454	daemon communications and to locate various resource files (such as	1667	daemon communications and to locate various resource files (such as
1455	C<.Xdefaults>)	1668	C<.Xdefaults>)
1456		1669
1457	=item B<XAPPLRESDIR>	1670	=item B<XAPPLRESDIR>
1458		1671
1459	Directory where various X resource files are being located.	1672	Directory where application-specific X resource files are located.
1460		1673
1461	=item B<XENVIRONMENT>	1674	=item B<XENVIRONMENT>
1462		1675
1463	If set and accessible, gives the name of a X resource file to be loaded by	1676	If set and accessible, gives the name of a X resource file to be loaded by
1464	@@RXVT_NAME@@.	1677	@@RXVT_NAME@@.
…		…
1469		1682
1470	=over 4	1683	=over 4
1471		1684
1472	=item B</usr/lib/X11/rgb.txt>	1685	=item B</usr/lib/X11/rgb.txt>
1473		1686
1474	Color names.	1687	Colour names.
1475		1688
1476	=back	1689	=back
1477		1690
1478	=head1 SEE ALSO	1691	=head1 SEE ALSO
1479		1692
1480	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1693	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1481		1694
1482	=head1 CURRENT PROJECT COORDINATOR	1695	=head1 CURRENT PROJECT COORDINATOR
1483		1696
1484	=over 4	1697	=over 4
1485		1698
…		…
1518	Project Coordinator (changes.txt 2.21a to 2.4.5)	1731	Project Coordinator (changes.txt 2.21a to 2.4.5)
1519		1732
1520	=item Geoff Wing L<< <gcw@pobox.com> >>	1733	=item Geoff Wing L<< <gcw@pobox.com> >>
1521		1734
1522	Rewrote screen display and text selection routines.	1735	Rewrote screen display and text selection routines.
1523		1736
1524	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1737	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1525		1738
1526	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1739	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1527		1740
1528	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1741	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1530		1743
1531	Project Coordinator (Changes 1.0 -)	1744	Project Coordinator (Changes 1.0 -)
1532		1745
1533	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1746	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1534		1747
1535	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1748	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1536		1749
1537	=back	1750	=back
1538		1751

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.219 by root, Thu Jun 7 16:06:23 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.219 by root, Thu Jun 7 16:06:23 2012 UTC