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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.133 by ayin, Sat Jul 28 20:15:18 2007 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.133 by ayin, Sat Jul 28 20:15:18 2007 UTC vs. Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.133 by ayin, Sat Jul 28 20:15:18 2007 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC