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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.111 by root, Tue Jan 31 00:25:16 2006 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 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 left-to-right 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 userfriendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
41	terminal emulator. In fact, the reason rxvt-unicode was born was solely	44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
42	because the author couldn't get C<mlterm> to use one font for latin1 and	45	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
46	display characters: The idea of a single unicode font which many other	49	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	50	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	51	to choose any font for any script freely.
49		52
50	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
51	it's predecessor, supports things such as XFT and ISO 14755 that are handy	54	its predecessor, supports things such as XFT and ISO 14755 that are handy
52	in i18n-environments, is faster, and has a lot less bugs than the original	55	in i18n-environments, is faster, and has a lot bugs less than the original
53	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
54		57
55	It is still faithfully following the original rxvt idea of being lean	58	It is still faithfully following the original rxvt idea of being lean
56	and nice on resources: for example, you can still configure rxvt-unicode	59	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of it's features to get a lean binary. It also comes with	60	without most of its features to get a lean binary. It also comes with
58	a client/daemon pair that lets you open any number of terminal windows	61	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	62	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
62		65
63	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
66		69
67	=head1 OPTIONS	70	=head1 OPTIONS
68		71
69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	72	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
102		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
107	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
108		116
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		118
111	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
112		120
113	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		122
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		126
120	I<Please note that transparency of any kind if completely unsupported by	127	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions!>	128
		129	Turn on/off illusion of a transparent window background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
		133
		134	I<Please address all transparency related issues to Sasha Vasko at
		135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
122		136
123	=item B<-fade> I<number>	137	=item B<-fade> I<number>
124		138
125	Fade the text by the given percentage when focus is lost. Small values	139	Fade the text by the given percentage when focus is lost. Small values
126	fade a little only, 100 completely replaces all colours by the fade	140	fade a little only, 100 completely replaces all colours by the fade
…		…
132	is opaque black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
133		147
134	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
135		149
136	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
137	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
138	non-tiled backgrounds, currently. See also the B<-sh> option that can be	152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
139	used to brighten or darken the image in addition to tinting it; resource	153	used to brighten or darken the image in addition to tinting it.
		154	Please note that certain tint colours can be applied on the server-side,
		155	thus yielding performance gain of two orders of magnitude. These colours are:
		156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		157	pure black and pure white colors essentially mean no tinting; resource
140	I<tintColor>. Example:	158	I<tintColor>. Example:
141		159
142	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
143		161
144	=item B<-sh>	162	=item B<-sh> I<number>
145		163
146	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
147	background image in addition to tinting it (i.e. B<-tint> must be	165	background image in addition to (or instead of) tinting it;
148	specified, too, e.g. C<-tint white>).	166	resource I<shading>.
		167
		168	=item B<-blt> I<string>
		169
		170	Specify background blending type. If background pixmap is specified
		171	at the same time as transparency - such pixmap will be blended over
		172	transparency image, using method specified. Supported values are :
		173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		177
		178	=item B<-blr> I<HxV>
		179
		180	Apply Gaussian Blur with the specified radii to the transparent
		181	background image. If single number is specified - both vertical and
		182	horizontal radii are considered to be the same. Setting one of the
		183	radii to 1 and another to a large number creates interesting effects
		184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		185	resource I<blurRadius>.
149		186
150	=item B<-bg> I<colour>	187	=item B<-bg> I<colour>
151		188
152	Window background colour; resource B<background>.	189	Window background colour; resource B<background>.
153		190
154	=item B<-fg> I<colour>	191	=item B<-fg> I<colour>
155		192
156	Window foreground colour; resource B<foreground>.	193	Window foreground colour; resource B<foreground>.
157		194
158	=item B<-pixmap> I<file[;geom]>	195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
159		196
160	Compile I<XPM>: Specify XPM file for the background and also optionally	197	Compile I<afterimage>: Specify image file for the background and also
161	specify its scaling with a geometry string. Note you may need to	198	optionally specify its scaling with a geometry string. Note you may need to
162	add quotes to avoid special shell interpretation of the C<;> in the	199	add quotes to avoid special shell interpretation of the C<;> in the
163	command-line; resource B<backgroundPixmap>.	200	command-line; for more details see resource B<backgroundPixmap>.
164		201
165	=item B<-cr> I<colour>	202	=item B<-cr> I<colour>
166		203
167	The cursor colour; resource B<cursorColor>.	204	The cursor colour; resource B<cursorColor>.
168		205
…		…
185	that are checked in order when trying to find glyphs for characters. The	222	that are checked in order when trying to find glyphs for characters. The
186	first font defines the cell size for characters; other fonts might be	223	first font defines the cell size for characters; other fonts might be
187	smaller, but not (in general) larger. A (hopefully) reasonable default	224	smaller, but not (in general) larger. A (hopefully) reasonable default
188	font list is always appended to it. See resource B<font> for more details.	225	font list is always appended to it. See resource B<font> for more details.
189		226
190	In short, to specify an X11 core font, just specify it's name or prefix it	227	In short, to specify an X11 core font, just specify its name or prefix it
191	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	228	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
192	e.g.:	229	e.g.:
193		230
194	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	231	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
195	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	232	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
213	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
214	for details.	251	for details.
215		252
216	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
217		254
218	Compile I<font-styles>: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
219	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
220	details.	257	details.
221		258
222	=item B<-name> I<name>	259	=item B<-name> I<name>
223		260
…		…
241		278
242	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
243		280
244	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
245		282
		283	=item B<-sr>\|B<+sr>
		284
		285	Put scrollbar on right/left; resource B<scrollBar_right>.
		286
		287	=item B<-st>\|B<+st>
		288
		289	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		290	resource B<scrollBar_floating>.
		291
246	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
247		293
248	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
249	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
250		296
…		…
256	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
257		303
258	Turn on/off scrolling with the scrollback buffer as new lines appear.	304	Turn on/off scrolling with the scrollback buffer as new lines appear.
259	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
260	B<scrollWithBuffer>.	306	B<scrollWithBuffer>.
261
262	=item B<-sr>\|B<+sr>
263
264	Put scrollbar on right/left; resource B<scrollBar_right>.
265
266	=item B<-st>\|B<+st>
267
268	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
269	resource B<scrollBar_floating>.
270		307
271	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
272		309
273	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
274	actual wide characters in the screen buffer, which makes it possible to	311	actual wide characters in the screen buffer, which makes it possible to
…		…
321		358
322	=item B<-lsp> I<number>	359	=item B<-lsp> I<number>
323		360
324	Compile I<frills>: Lines (pixel height) to insert between each row of	361	Compile I<frills>: Lines (pixel height) to insert between each row of
325	the display. Useful to work around font rendering problems; resource	362	the display. Useful to work around font rendering problems; resource
326	B<linespace>.	363	B<lineSpace>.
327		364
328	=item B<-tn> I<termname>	365	=item B<-tn> I<termname>
329		366
330	This option specifies the name of the terminal type to be set in the	367	This option specifies the name of the terminal type to be set in the
331	B<TERM> environment variable. This terminal type must exist in the	368	B<TERM> environment variable. This terminal type must exist in the
…		…
385	for more info.	422	for more info.
386		423
387	=item B<-tcw>	424	=item B<-tcw>
388		425
389	Change the meaning of triple-click selection with the left mouse	426	Change the meaning of triple-click selection with the left mouse
		427	button. Only effective when the original (non-perl) selection code is
390	button. Instead of selecting a full line it will extend the selection the	428	in-use. Instead of selecting a full line it will extend the selection to
391	end of the logical line only. resource B<tripleclickwords>.	429	the end of the logical line only. resource B<tripleclickwords>.
392		430
393	=item B<-insecure>	431	=item B<-insecure>
394		432
395	Enable "insecure" mode, which currently enables most of the escape	433	Enable "insecure" mode, which currently enables most of the escape
396	sequences that echo strings. See the resource B<insecure> for more	434	sequences that echo strings. See the resource B<insecure> for more
…		…
417	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	455	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
418	will not immediately destroy its window when the program executed within	456	will not immediately destroy its window when the program executed within
419	it exits. Instead, it will wait till it is being killed or closed by the	457	it exits. Instead, it will wait till it is being killed or closed by the
420	user; resource B<hold>.	458	user; resource B<hold>.
421		459
		460	=item B<-xrm> I<string>
		461
		462	Works like the X Toolkit option of the same name, by adding the I<string>
		463	as if it were specified in a resource file. Resource values specified this
		464	way take precedence over all other resource specifications.
		465
		466	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		467	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		468	options can be specified as long-options on the commandline, so use
		469	of B<-xrm> is mostly limited to cases where you want to specify other
		470	resources (e.g. for input methods) or for compatibility with other
		471	programs.
		472
422	=item B<-keysym.>I<sym> I<string>	473	=item B<-keysym.>I<sym> I<string>
423		474
424	Remap a key symbol. See resource B<keysym>.	475	Remap a key symbol. See resource B<keysym>.
425		476
426	=item B<-embed> I<windowid>	477	=item B<-embed> I<windowid>
427		478
428	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	479	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
429	which enables applications to easily embed a terminal.	480	which enables applications to easily embed a terminal.
430		481
431	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	482	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
432	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	483	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
433	quite a bit, so don't expect it to keep some specific state. It's best to	484	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
436	The window will not be destroyed when @@RXVT_NAME@@ exits.	487	The window will not be destroyed when @@RXVT_NAME@@ exits.
437		488
438	It might be useful to know that @@RXVT_NAME@@ will not close file	489	It might be useful to know that @@RXVT_NAME@@ will not close file
439	descriptors passed to it (except for stdin/out/err, of course), so you	490	descriptors passed to it (except for stdin/out/err, of course), so you
440	can use file descriptors to communicate with the programs within the	491	can use file descriptors to communicate with the programs within the
441	terminal. This works regardless of wether the C<-embed> option was used or	492	terminal. This works regardless of whether the C<-embed> option was used or
442	not.	493	not.
443		494
444	Here is a short Gtk2-perl snippet that illustrates how this option can be	495	Here is a short Gtk2-perl snippet that illustrates how this option can be
445	used (a longer example is in F<doc/embed>):	496	used (a longer example is in F<doc/embed>):
446		497
…		…
451	});	502	});
452		503
453	=item B<-pty-fd> I<file descriptor>	504	=item B<-pty-fd> I<file descriptor>
454		505
455	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	506	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
456	pair but instead use the given filehandle as the tty master. This is	507	pair but instead use the given file descriptor as the tty master. This is
457	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	508	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458	without having to run a program within it.	509	without having to run a program within it.
459		510
460	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	511	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
461	entries and will not tinker with pty/tty permissions - you have to do that	512	entries and will not tinker with pty/tty permissions - you have to do that
462	yourself if you want that.	513	yourself if you want that.
463		514
464	As an extremely special case, specifying C<-1> will completely suppress	515	As an extremely special case, specifying C<-1> will completely suppress
465	pty/tty operations.	516	pty/tty operations, which is probably only useful in conjunction with some
		517	perl extension that manages the terminal.
466		518
467	Here is a example in perl that illustrates how this option can be used (a	519	Here is a example in perl that illustrates how this option can be used (a
468	longer example is in F<doc/pty-fd>):	520	longer example is in F<doc/pty-fd>):
469		521
470	use IO::Pty;	522	use IO::Pty;
…		…
484	Comma-separated list of perl extension scripts to use (or not to use) in	536	Comma-separated list of perl extension scripts to use (or not to use) in
485	this terminal instance. See resource B<perl-ext> for details.	537	this terminal instance. See resource B<perl-ext> for details.
486		538
487	=back	539	=back
488		540
489	=head1 RESOURCES (available also as long-options)	541	=head1 RESOURCES
490		542
491	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	543	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
492	options) compiled into your version.	544	options) compiled into your version. All resources are also available as
		545	long-options.
493		546
494	You can set and change the resources using X11 tools like B<xrdb>. Many	547	You can set and change the resources using X11 tools like B<xrdb>. Many
495	distribution do also load settings from the B<~/.Xresources> file when X	548	distribution do also load settings from the B<~/.Xresources> file when X
496	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	549	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
497	with later settings overwriting earlier ones:	550	with later settings overwriting earlier ones:
…		…
499	1. system-wide app-defaults file, either locale-dependent OR global	552	1. system-wide app-defaults file, either locale-dependent OR global
500	2. app-defaults file in $XAPPLRESDIR	553	2. app-defaults file in $XAPPLRESDIR
501	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	554	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
502	4. SCREEN_RESOURCES for the current screen	555	4. SCREEN_RESOURCES for the current screen
503	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	556	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		557	6. resources specified via -xrm on the commandline
504		558
505	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	559	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
506	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	560	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
507	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	561	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
508	configured, while the class name B<URxvt> allows resources unique to	562	configured, while the class name B<URxvt> allows resources unique to
…		…
563	Use the specified colour to display underlined characters when the	617	Use the specified colour to display underlined characters when the
564	foreground colour is the default.	618	foreground colour is the default.
565		619
566	=item B<colorRV:> I<colour>	620	=item B<colorRV:> I<colour>
567		621
568	Use the specified colour as the background for reverse video	622	Use the specified colour as the background for reverse video characters
569	characters.	623	when OPTION_HC is disabled (--disable-frills).
570		624
571	=item B<underlineColor:> I<colour>	625	=item B<underlineColor:> I<colour>
572		626
573	If set, use the specified colour as the colour for the underline	627	If set, use the specified colour as the colour for the underline
574	itself. If unset, use the foreground colour.	628	itself. If unset, use the foreground colour.
…		…
590	option B<-rv>. B<False>: regular screen colours [default]; option	644	option B<-rv>. B<False>: regular screen colours [default]; option
591	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	645	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
592		646
593	=item B<jumpScroll:> I<boolean>	647	=item B<jumpScroll:> I<boolean>
594		648
595	B<True>: specify that jump scrolling should be used. When scrolling	649	B<True>: specify that jump scrolling should be used. When receiving lots
596	quickly, fewer screen updates are performed [default]; option B<-j>.	650	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		651	has been read, resulting in fewer updates while still displaying every
		652	received line; option B<-j>.
		653
597	B<False>: specify that smooth scrolling should be used; option B<+j>.	654	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		655	force a screen refresh on each new line it received; option B<+j>.
598		656
599	=item B<inheritPixmap:> I<boolean>	657	=item B<skipScroll:> I<boolean>
600		658
601	B<True>: make the background inherit the parent windows' pixmap, giving	659	B<True>: (the default) specify that skip scrolling should be used. When
602	artificial transparency. B<False>: do not inherit the parent windows'	660	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
603	pixmap.	661	(around 60 times per second), resulting in far fewer updates. This can
		662	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		663	option B<-ss>.
604		664
605	I<Please note that transparency of any kind if completely unsupported by	665	B<False>: specify that everything is to be displayed, even
606	the author. Don't bug him with installation questions!>	666	if the refresh is too fast for the human eye to read anything (or the
		667	monitor to display anything); option B<+ss>.
		668
		669	=item B<transparent:> I<boolean>
		670
		671	Turn on/off illusion of a transparent window background.
		672
		673	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		674	future versions.
		675
		676	I<Please address all transparency related issues to Sasha Vasko at
		677	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
607		678
608	=item B<fading:> I<number>	679	=item B<fading:> I<number>
609		680
610	Fade the text by the given percentage when focus is lost; option B<-fade>.	681	Fade the text by the given percentage when focus is lost; option B<-fade>.
611		682
…		…
619	Tint the transparent background pixmap with the given colour; option	690	Tint the transparent background pixmap with the given colour; option
620	B<-tint>.	691	B<-tint>.
621		692
622	=item B<shading:> I<number>	693	=item B<shading:> I<number>
623		694
624	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	695	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
625	image in addition to tinting it.	696	in addition to tinting it; option B<-sh>.
		697
		698	=item B<blendType:> I<string>
		699
		700	Specify background blending type; option B<-blt>.
		701
		702	=item B<blurRadius:> I<number>
		703
		704	Apply Gaussian Blurr with the specified radius to the transparent
		705	background image; option B<-blr>.
626		706
627	=item B<scrollColor:> I<colour>	707	=item B<scrollColor:> I<colour>
628		708
629	Use the specified colour for the scrollbar [default #B2B2B2].	709	Use the specified colour for the scrollbar [default #B2B2B2].
630		710
…		…
636	=item B<borderColor:> I<colour>	716	=item B<borderColor:> I<colour>
637		717
638	The colour of the border around the text area and between the scrollbar	718	The colour of the border around the text area and between the scrollbar
639	and the text.	719	and the text.
640		720
641	=item B<backgroundPixmap:> I<file[;geom]>	721	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
642		722
643	Use the specified XPM file (note the `.xpm' extension is optional) for	723	Use the specified image file for the background and also
644	the background and also optionally specify its scaling with a geometry	724	optionally specify its scaling with a geometry string B<WxH+X+Y>,
645	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	725	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
646	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	726	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
647	centre (percent). A scale of 0 displays the image with tiling. A scale	727	centre (percent). A scale of 0 displays the image with tiling. A scale
648	of 1 displays the image without any scaling. A scale of 2 to 9	728	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
649	specifies an integer number of images in that direction. No image will	729	an integer number of images in that direction. No image will be magnified
650	be magnified beyond 10 times its original size. The maximum permitted	730	beyond 10 times its original size. The maximum permitted scale is 1000.
651	scale is 1000. [default 0x0+50+50]	731	Additional operations can be specified after colon B<:op1:op2...>.
		732	Supported operations are:
		733
		734	tile force background image to be tiled and not scaled. Equivalent to 0x0
		735	propscale will scale image keeping proportions
		736	auto will scale image to match window size. Equivalent to 100x100
		737	hscale will scale image horizontally to the window size
		738	vscale will scale image vertically to the window size
		739	scale will scale image to match window size
		740	root will tile image as if it was a root window background, auto-adjusting
		741	whenever terminal window moves
		742
		743	If used in conjunction with B<-tr> option, the specified pixmap will be
		744	blended over transparency image using either alpha-blending, or any
		745	other blending type, specified with B<-blt "type"> option.
652		746
653	=item B<path:> I<path>	747	=item B<path:> I<path>
654		748
655	Specify the colon-delimited search path for finding XPM files.	749	Specify the colon-delimited search path for finding background image files.
656		750
657	=item B<font:> I<fontlist>	751	=item B<font:> I<fontlist>
658		752
659	Select the fonts to be used. This is a comma separated list of font names	753	Select the fonts to be used. This is a comma separated list of font names
660	that are checked in order when trying to find glyphs for characters. The	754	that are checked in order when trying to find glyphs for characters. The
…		…
717	text font will being used for the given style.	811	text font will being used for the given style.
718		812
719	=item B<intensityStyles:> I<boolean>	813	=item B<intensityStyles:> I<boolean>
720		814
721	When font styles are not enabled, or this option is enabled (B<True>,	815	When font styles are not enabled, or this option is enabled (B<True>,
722	option B<-is>, the default), bold and italic font styles imply high	816	option B<-is>, the default), bold/blink font styles imply high
723	intensity foreground/backround colours. Disabling this option (B<False>,	817	intensity foreground/background colours. Disabling this option (B<False>,
724	option B<+is>) disables this behaviour, the high intensity colours are not	818	option B<+is>) disables this behaviour, the high intensity colours are not
725	reachable.	819	reachable.
726
727	=item B<selectstyle:> I<mode>
728
729	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
730	xterm style with 2.20 old word selection, or anything else which gives
731	xterm style selection.
732
733	=item B<scrollstyle:> I<mode>
734
735	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
736	the author's favourite.
737		820
738	=item B<title:> I<string>	821	=item B<title:> I<string>
739		822
740	Set window title string, the default title is the command-line	823	Set window title string, the default title is the command-line
741	specified after the B<-e> option, if any, otherwise the application	824	specified after the B<-e> option, if any, otherwise the application
…		…
750	=item B<mapAlert:> I<boolean>	833	=item B<mapAlert:> I<boolean>
751		834
752	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	835	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
753	de-iconify (map) on receipt of a bell character [default].	836	de-iconify (map) on receipt of a bell character [default].
754		837
		838	=item B<urgentOnBell:> I<boolean>
		839
		840	B<True>: set the urgency hint for the wm on receipt of a bell character.
		841	B<False>: do not set the urgency hint [default].
		842
755	=item B<visualBell:> I<boolean>	843	=item B<visualBell:> I<boolean>
756		844
757	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	845	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
758	B<False>: no visual bell [default]; option B<+vb>.	846	B<False>: no visual bell [default]; option B<+vb>.
759		847
…		…
780	Example:	868	Example:
781		869
782	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	870	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783		871
784	This creates a new file in your home directory with the screen contents	872	This creates a new file in your home directory with the screen contents
785	everytime you hit C<Print>.	873	every time you hit C<Print>.
		874
		875	=item B<scrollstyle:> I<mode>
		876
		877	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		878	the author's favourite.
786		879
787	=item B<scrollBar:> I<boolean>	880	=item B<scrollBar:> I<boolean>
788		881
789	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	882	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790	disable the scrollbar; option B<+sb>.	883	disable the scrollbar; option B<+sb>.
…		…
812		905
813	=item B<scrollWithBuffer:> I<boolean>	906	=item B<scrollWithBuffer:> I<boolean>
814		907
815	B<True>: scroll with scrollback buffer when tty receives new lines (and	908	B<True>: scroll with scrollback buffer when tty receives new lines (and
816	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	909	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
817	with scrollback buffer when tty recieves new lines; option B<+sw>.	910	with scrollback buffer when tty receives new lines; option B<+sw>.
818		911
819	=item B<scrollTtyKeypress:> I<boolean>	912	=item B<scrollTtyKeypress:> I<boolean>
820		913
821	B<True>: scroll to bottom when a non-special key is pressed. Special keys	914	B<True>: scroll to bottom when a non-special key is pressed. Special keys
822	are those which are intercepted by rxvt-unicode for special handling and	915	are those which are intercepted by rxvt-unicode for special handling and
…		…
853	=item B<termName:> I<termname>	946	=item B<termName:> I<termname>
854		947
855	Specifies the terminal type name to be set in the B<TERM> environment	948	Specifies the terminal type name to be set in the B<TERM> environment
856	variable; option B<-tn>.	949	variable; option B<-tn>.
857		950
858	=item B<linespace:> I<number>	951	=item B<lineSpace:> I<number>
859		952
860	Specifies number of lines (pixel height) to insert between each row of	953	Specifies number of lines (pixel height) to insert between each row of
861	the display [default 0]; option B<-lsp>.	954	the display [default 0]; option B<-lsp>.
862		955
863	=item B<meta8:> I<boolean>	956	=item B<meta8:> I<boolean>
…		…
915	=item B<cutchars:> I<string>	1008	=item B<cutchars:> I<string>
916		1009
917	The characters used as delimiters for double-click word selection	1010	The characters used as delimiters for double-click word selection
918	(whitespace delimiting is added automatically if resource is given).	1011	(whitespace delimiting is added automatically if resource is given).
919		1012
920	When the selection extension is in use (the default if compiled in, see	1013	When the perl selection extension is in use (the default if compiled
921	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1014	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
922	will be created (if the resource exists, otherwise, no regex will be	1015	characters will be created (if the resource exists, otherwise, no regex
923	created). In this mode, characters outside ISO-8859-1 can be used.	1016	will be created). In this mode, characters outside ISO-8859-1 can be used.
924		1017
925	When the selection extension is not used, only ISO-8859-1 characters can	1018	When the selection extension is not used, only ISO-8859-1 characters can
926	be used. If not specified, the built-in default is used:	1019	be used. If not specified, the built-in default is used:
927		1020
928	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1021	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
929		1022
930	=item B<preeditType:> I<style>	1023	=item B<preeditType:> I<style>
931		1024
932	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1025	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
933		1026
…		…
987		1080
988	Turn on/off secondary screen (default enabled).	1081	Turn on/off secondary screen (default enabled).
989		1082
990	=item B<secondaryScroll:> I<boolean>	1083	=item B<secondaryScroll:> I<boolean>
991		1084
992	Turn on/off secondary screen scroll (default enabled). If the this	1085	Turn on/off secondary screen scroll (default enabled). If this
993	option is enabled, scrolls on the secondary screen will change the	1086	option is enabled, scrolls on the secondary screen will change the
994	scrollback buffer and switching to/from the secondary screen will	1087	scrollback buffer and switching to/from the secondary screen will
995	instead scroll the screen up.	1088	instead scroll the screen up.
996		1089
997	=item B<hold>: I<boolean>	1090	=item B<hold>: I<boolean>
…		…
1021	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1114	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1022	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1115	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1023	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1116	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1024	performed in an exact manner; however, the closest match is assured.	1117	performed in an exact manner; however, the closest match is assured.
1025		1118
1026	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1119	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1027	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1120	number), see RESOURCES in C<man 7 X> for futher details.
1028	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1029	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1030	can start or end with whitespace.
1031
1032	Please note that you need to double the C<\> in resource files, as
1033	Xlib itself does it's own de-escaping (you can use C<\033> instead of
1034	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1035	processing).
1036		1121
1037	You can define a range of keysyms in one shot by providing a I<string>	1122	You can define a range of keysyms in one shot by providing a I<string>
1038	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1123	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1039	should be a character not used by the strings.	1124	should be a character not used by the strings.
1040		1125
1041	Its usage can be demonstrated by an example:	1126	Its usage can be demonstrated by an example:
1042		1127
1043	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1128	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1107	example, C<default,-selection> will use all the default extension except	1192	example, C<default,-selection> will use all the default extension except
1108	C<selection>.	1193	C<selection>.
1109		1194
1110	Extension names can also be followed by an argument in angle brackets	1195	Extension names can also be followed by an argument in angle brackets
1111	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1196	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1197	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1113	multiple times with different arguments will pass multiple arguments to	1198	multiple times with different arguments will pass multiple arguments to
1114	the extension.	1199	the extension.
1115		1200
1116	Each extension is looked up in the library directories, loaded if	1201	Each extension is looked up in the library directories, loaded if
1117	necessary, and bound to the current terminal instance.	1202	necessary, and bound to the current terminal instance.
…		…
1153	(default: C<M-s>).	1238	(default: C<M-s>).
1154		1239
1155	=item B<urlLauncher>: I<string>	1240	=item B<urlLauncher>: I<string>
1156		1241
1157	Specifies the program to be started with a URL argument. Used by the	1242	Specifies the program to be started with a URL argument. Used by the
1158	C<selection-popup> and C<mark-urls> perl extensions.	1243	C<selection-popup> and C<matcher> perl extensions.
1159		1244
1160	=item B<transient-for>: I<windowid>	1245	=item B<transient-for>: I<windowid>
1161		1246
1162	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1247	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163		1248
1164	=item B<override-redirect>: I<boolean>	1249	=item B<override-redirect>: I<boolean>
1165		1250
1166	Compile I<frills>: Sets override-redirect for the terminal window, making	1251	Compile I<frills>: Sets override-redirect for the terminal window, making
1167	it almost invisible to window managers; option B<-override-redirect>.	1252	it almost invisible to window managers; option B<-override-redirect>.
		1253
		1254	=item B<iso14755_52:> I<boolean>
		1255
		1256	Turn on/off ISO 14755 5.2 mode (default enabled).
1168		1257
1169	=back	1258	=back
1170		1259
1171	=head1 THE SCROLLBAR	1260	=head1 THE SCROLLBAR
1172		1261
…		…
1191	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1280	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1192	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1281	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1193	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1282	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1194	respectively.	1283	respectively.
1195		1284
1196	=head1 TEXT SELECTION AND INSERTION	1285	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1197		1286
1198	The behaviour of text selection and insertion mechanism is similar to	1287	The behaviour of text selection and insertion/pasting mechanism is similar
1199	I<xterm>(1).	1288	to I<xterm>(1).
1200		1289
1201	=over 4	1290	=over 4
1202		1291
1203	=item B<Selection>:	1292	=item B<Selecting>:
1204		1293
1205	Left click at the beginning of the region, drag to the end of the region	1294	Left click at the beginning of the region, drag to the end of the region
1206	and release; Right click to extend the marked region; Left double-click	1295	and release; Right click to extend the marked region; Left double-click
1207	to select a word; Left triple-click to select the entire logical line	1296	to select a word; Left triple-click to select the entire logical line
1208	(which can span multiple screen lines), unless modified by resource	1297	(which can span multiple screen lines), unless modified by resource
…		…
1212	(Compile: I<frills>) will create a rectangular selection instead of a	1301	(Compile: I<frills>) will create a rectangular selection instead of a
1213	normal one. In this mode, every selected row becomes its own line in the	1302	normal one. In this mode, every selected row becomes its own line in the
1214	selection, and trailing whitespace is visually underlined and removed from	1303	selection, and trailing whitespace is visually underlined and removed from
1215	the selection.	1304	the selection.
1216		1305
1217	=item B<Insertion>:	1306	=item B<Pasting>:
1218		1307
1219	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1308	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1220	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1309	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1221	Meta modifier) to be inserted as if it had been typed on the keyboard.	1310	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1222		1311
1223	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1312	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224	inserted too.	1313	inserted too.
1225		1314
1226	=back	1315	=back
…		…
1243		1332
1244	=head1 ISO 14755 SUPPORT	1333	=head1 ISO 14755 SUPPORT
1245		1334
1246	ISO 14755 is a standard for entering and viewing unicode characters	1335	ISO 14755 is a standard for entering and viewing unicode characters
1247	and character codes using the keyboard. It consists of 4 parts. The	1336	and character codes using the keyboard. It consists of 4 parts. The
1248	first part is available rxvt-unicode has been compiled with	1337	first part is available if rxvt-unicode has been compiled with
1249	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1338	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1250	with C<--enable-iso14755>.	1339	with C<--enable-iso14755>.
1251		1340
1252	=over 4	1341	=over 4
1253		1342
…		…
1273	This mode lets you input characters representing the keycap symbols of	1362	This mode lets you input characters representing the keycap symbols of
1274	your keyboard, if representable in the current locale encoding.	1363	your keyboard, if representable in the current locale encoding.
1275		1364
1276	Start by pressing C<Control> and C<Shift> together, then releasing	1365	Start by pressing C<Control> and C<Shift> together, then releasing
1277	them. The next special key (cursor keys, home etc.) you enter will not	1366	them. The next special key (cursor keys, home etc.) you enter will not
1278	invoke it's usual function but instead will insert the corresponding	1367	invoke its usual function but instead will insert the corresponding
1279	keycap symbol. The symbol will only be entered when the key has been	1368	keycap symbol. The symbol will only be entered when the key has been
1280	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1369	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1281	C<ISO Level 2 Switch>, although your intention might have been to enter a	1370	C<ISO Level 2 Switch>, although your intention might have been to enter a
1282	reverse tab (Shift-Tab).	1371	reverse tab (Shift-Tab).
1283		1372
…		…
1346	It is also possible to specify the colour values of B<foreground>,	1435	It is also possible to specify the colour values of B<foreground>,
1347	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1436	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1348	a number 0-15, as a convenient shorthand to reference the colour name of	1437	a number 0-15, as a convenient shorthand to reference the colour name of
1349	color0-color15.	1438	color0-color15.
1350		1439
		1440	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1441	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1442	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1443	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1444
		1445	Together, all those colours implement the 88 colour xterm colours. Only
		1446	the first 16 can be changed using resources currently, the rest can only
		1447	be changed via command sequences ("escape codes").
		1448
1351	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1449	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1352	always swapping the foreground/background colours. This is in contrast to	1450	always swapping the foreground/background colours. This is in contrast to
1353	I<xterm>(1) where the colours are only swapped if they have not otherwise	1451	I<xterm>(1) where the colours are only swapped if they have not otherwise
1354	been specified. For example,	1452	been specified. For example,
1355		1453
…		…
1363	=back	1461	=back
1364		1462
1365	=head2 ALPHA CHANNEL SUPPORT	1463	=head2 ALPHA CHANNEL SUPPORT
1366		1464
1367	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1465	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1368	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1466	their act together, rxvt-unicode will do it's own alpha channel management:
1369	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1467
1370	in addition to the ones provided by X, where the additional A component	1468	You can prefix any color with an opaquenes percentage enclosed in
		1469	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1470	(0-100) that specifies the opacity of the color, where C<0> is completely
		1471	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1472	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1473	is the recommended format to specify transparency values, and works with
		1474	all ways to specify a colour.
		1475
		1476	For complete control, rxvt-unicode also supports
		1477	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1478	specifications, where the additional C<aaaa> component specifies opacity
1371	specifies opacity (alpha) values. The minimum value of C<0> is completely	1479	(alpha) values. The minimum value of C<0000> is completely transparent,
1372	transparent). You can also prefix any color with C<[a]>, where C<a> is on	1480	while C<ffff> is completely opaque). The two example colours from
1373	to four hex digits specifiying the opacity value.	1481	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1482	C<rgba:0000/ff00/0000/f332>.
1374		1483
1375	You probably need to specify B<"-depth 32">, too, and have the luck that	1484	You probably need to specify B<"-depth 32">, too, to force a visual with
1376	your X-server uses ARGB pixel layout, as X is far from just supporting	1485	alpha channels, and have the luck that your X-server uses ARGB pixel
1377	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1486	layout, as X is far from just supporting ARGB visuals out of the box, and
		1487	rxvt-unicode just fudges around.
1378		1488
1379	For example, the following selects an almost completely transparent red	1489	For example, the following selects an almost completely transparent black
1380	background, and an almost opaque pink foreground:	1490	background, and an almost opaque pink foreground:
1381		1491
1382	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"	1492	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1383		1493
1384	I<Please note that transparency of any kind if completely unsupported by	1494	When not using a background image, then the interpretation of the
1385	the author. Don't bug him with installation questions!>	1495	alpha channel is up to your compositing manager (most interpret it as
		1496	transparency of course).
		1497
		1498	When using a background pixmap or pseudo-transparency, then the background
		1499	colour will always behave as if it were completely transparent (so the
		1500	background image shows instead), regardless of how it was specified, while
		1501	other colours will either be transparent as specified (the background
		1502	image will show through) on servers supporting the RENDER extension, or
		1503	fully opaque on servers not supporting the RENDER EXTENSION.
		1504
		1505	Please note that due to bugs in Xft, specifying alpha values might result
		1506	in garbage being displayed when the X-server does not support the RENDER
		1507	extension.
1386		1508
1387	=head1 ENVIRONMENT	1509	=head1 ENVIRONMENT
1388		1510
1389	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1511	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1390		1512
1391	=over 4	1513	=over 4
1392		1514
1393	=item B<TERM>	1515	=item B<TERM>
1394		1516
1395	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1517	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1396	resources or on the commandline.	1518	resources or on the command line.
1397		1519
1398	=item B<COLORTERM>	1520	=item B<COLORTERM>
1399		1521
1400	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1522	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1401	compiled with XPM support, and optionally with the added extension	1523	compiled with background image support, and optionally with the added
1402	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1524	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1525	screen.
1403		1526
1404	=item B<COLORFGBG>	1527	=item B<COLORFGBG>
1405		1528
1406	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1529	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1407	the colour code used as default foreground/text colour (or the string	1530	the colour code used as default foreground/text colour (or the string
1408	C<default> to indicate that the default-colour escape sequence is to be	1531	C<default> to indicate that the default-colour escape sequence is to be
1409	used), C<bg> is the colour code used as default background colour (or the	1532	used), C<bg> is the colour code used as default background colour (or the
1410	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1533	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1411	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1534	was compiled with background image support. Libraries like C<ncurses>
1412	(and do) use this information to optimize screen output.	1535	and C<slang> can (and do) use this information to optimize screen output.
1413		1536
1414	=item B<WINDOWID>	1537	=item B<WINDOWID>
1415		1538
1416	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1539	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1417	window, which usually has subwindows for the scrollbar, the terminal	1540	window, which usually has subwindows for the scrollbar, the terminal
…		…
1423	C<--with-terminfo=PATH>.	1546	C<--with-terminfo=PATH>.
1424		1547
1425	=item B<DISPLAY>	1548	=item B<DISPLAY>
1426		1549
1427	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1550	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1428	display in it's child processes.	1551	display in its child processes.
1429		1552
1430	=item B<SHELL>	1553	=item B<SHELL>
1431		1554
1432	The shell to be used for command execution, defaults to C</bin/sh>.	1555	The shell to be used for command execution, defaults to C</bin/sh>.
1433		1556
…		…
1475		1598
1476	=item Project Coordinator	1599	=item Project Coordinator
1477		1600
1478	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1601	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1479		1602
1480	L<http://software.schmorp.de/#rxvt-unicode>	1603	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1481		1604
1482	=back	1605	=back
1483		1606
1484	=head1 AUTHORS	1607	=head1 AUTHORS
1485		1608
…		…
1508	Project Coordinator (changes.txt 2.21a to 2.4.5)	1631	Project Coordinator (changes.txt 2.21a to 2.4.5)
1509		1632
1510	=item Geoff Wing L<< <gcw@pobox.com> >>	1633	=item Geoff Wing L<< <gcw@pobox.com> >>
1511		1634
1512	Rewrote screen display and text selection routines.	1635	Rewrote screen display and text selection routines.
1513		1636
1514	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1637	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1515		1638
1516	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1639	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1517		1640
1518	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1641	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.111 by root, Tue Jan 31 00:25:16 2006 UTC vs. Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.111 by root, Tue Jan 31 00:25:16 2006 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC