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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.108 by root, Sun Jan 29 21:45:47 2006 UTC vs.
Revision 1.161 by ayin, Sat Jan 26 14:24:42 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
…		…
95	respected). In the absence of this option, the display specified by the	98	respected). In the absence of this option, the display specified by the
96	B<DISPLAY> environment variable is used.	99	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<frills>: 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>.	126
		127	=item B<-tr>\|B<+tr>
		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@@)!>
119		136
120	=item B<-fade> I<number>	137	=item B<-fade> I<number>
121		138
122	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
123	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
124	colour; resource B<fading>.	141	colour; resource B<fading>.
125		142
126	=item B<-fadecolor> I<colour>	143	=item B<-fadecolor> I<colour>
127		144
128	Fade to this colour when fading is used (see B<-fade>). The default colour	145	Fade to this colour when fading is used (see B<-fade>). The default colour
129	is black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
130		147
131	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
132		149
133	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
134	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
135	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
136	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
137	I<tintColor>. Example:	158	I<tintColor>. Example:
138		159
139	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
140		161
141	=item B<-sh>	162	=item B<-sh> I<number>
142		163
143	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
144	background image in addition to tinting it (i.e. B<-tint> must be	165	background image in addition to (or instead of) tinting it;
145	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>.
146		186
147	=item B<-bg> I<colour>	187	=item B<-bg> I<colour>
148		188
149	Window background colour; resource B<background>.	189	Window background colour; resource B<background>.
150		190
151	=item B<-fg> I<colour>	191	=item B<-fg> I<colour>
152		192
153	Window foreground colour; resource B<foreground>.	193	Window foreground colour; resource B<foreground>.
154		194
155	=item B<-pixmap> I<file[;geom]>	195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
156		196
157	Compile I<XPM>: Specify XPM file for the background and also optionally	197	Compile I<afterimage>: Specify image file for the background and also
158	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
159	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
160	command-line; resource B<backgroundPixmap>.	200	command-line; for more details see resource B<backgroundPixmap>.
161		201
162	=item B<-cr> I<colour>	202	=item B<-cr> I<colour>
163		203
164	The cursor colour; resource B<cursorColor>.	204	The cursor colour; resource B<cursorColor>.
165		205
…		…
182	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
183	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
184	smaller, but not (in general) larger. A (hopefully) reasonable default	224	smaller, but not (in general) larger. A (hopefully) reasonable default
185	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.
186		226
187	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
188	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:>,
189	e.g.:	229	e.g.:
190		230
191	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	231	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	232	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
210	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
211	for details.	251	for details.
212		252
213	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
214		254
215	Compile I<font-styles>: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
216	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
217	details.	257	details.
218		258
219	=item B<-name> I<name>	259	=item B<-name> I<name>
220		260
…		…
238		278
239	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
240		280
241	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
242		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
243	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
244		293
245	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
246	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
247		296
…		…
253	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
254		303
255	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.
256	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
257	B<scrollWithBuffer>.	306	B<scrollWithBuffer>.
258
259	=item B<-sr>\|B<+sr>
260
261	Put scrollbar on right/left; resource B<scrollBar_right>.
262
263	=item B<-st>\|B<+st>
264
265	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
266	resource B<scrollBar_floating>.
267		307
268	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
269		309
270	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
271	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
…		…
318		358
319	=item B<-lsp> I<number>	359	=item B<-lsp> I<number>
320		360
321	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
322	the display. Useful to work around font rendering problems; resource	362	the display. Useful to work around font rendering problems; resource
323	B<linespace>.	363	B<lineSpace>.
324		364
325	=item B<-tn> I<termname>	365	=item B<-tn> I<termname>
326		366
327	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
328	B<TERM> environment variable. This terminal type must exist in the	368	B<TERM> environment variable. This terminal type must exist in the
…		…
382	for more info.	422	for more info.
383		423
384	=item B<-tcw>	424	=item B<-tcw>
385		425
386	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
387	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
388	end of the logical line only. resource B<tripleclickwords>.	429	the end of the logical line only. resource B<tripleclickwords>.
389		430
390	=item B<-insecure>	431	=item B<-insecure>
391		432
392	Enable "insecure" mode, which currently enables most of the escape	433	Enable "insecure" mode, which currently enables most of the escape
393	sequences that echo strings. See the resource B<insecure> for more	434	sequences that echo strings. See the resource B<insecure> for more
…		…
414	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@@
415	will not immediately destroy its window when the program executed within	456	will not immediately destroy its window when the program executed within
416	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
417	user; resource B<hold>.	458	user; resource B<hold>.
418		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
419	=item B<-keysym.>I<sym> I<string>	473	=item B<-keysym.>I<sym> I<string>
420		474
421	Remap a key symbol. See resource B<keysym>.	475	Remap a key symbol. See resource B<keysym>.
422		476
423	=item B<-embed> I<windowid>	477	=item B<-embed> I<windowid>
424		478
425	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,
426	which enables applications to easily embed a terminal.	480	which enables applications to easily embed a terminal.
427		481
428	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
429	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
430	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
…		…
433	The window will not be destroyed when @@RXVT_NAME@@ exits.	487	The window will not be destroyed when @@RXVT_NAME@@ exits.
434		488
435	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
436	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
437	can use file descriptors to communicate with the programs within the	491	can use file descriptors to communicate with the programs within the
438	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
439	not.	493	not.
440		494
441	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
442	used (a longer example is in F<doc/embed>):	496	used (a longer example is in F<doc/embed>):
443		497
…		…
448	});	502	});
449		503
450	=item B<-pty-fd> I<file descriptor>	504	=item B<-pty-fd> I<file descriptor>
451		505
452	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
453	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
454	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
455	without having to run a program within it.	509	without having to run a program within it.
456		510
457	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
458	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
459	yourself if you want that.	513	yourself if you want that.
460		514
461	As an extremely special case, specifying C<-1> will completely suppress	515	As an extremely special case, specifying C<-1> will completely suppress
462	pty/tty operations.	516	pty/tty operations, which is probably only useful in conjunction with some
		517	perl extension that manages the terminal.
463		518
464	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
465	longer example is in F<doc/pty-fd>):	520	longer example is in F<doc/pty-fd>):
466		521
467	use IO::Pty;	522	use IO::Pty;
…		…
481	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
482	this terminal instance. See resource B<perl-ext> for details.	537	this terminal instance. See resource B<perl-ext> for details.
483		538
484	=back	539	=back
485		540
486	=head1 RESOURCES (available also as long-options)	541	=head1 RESOURCES
487		542
488	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	543	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
489	options) compiled into your version.	544	options) compiled into your version. All resources are also available as
		545	long-options.
490		546
491	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
492	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
493	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	549	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
494	with later settings overwriting earlier ones:	550	with later settings overwriting earlier ones:
…		…
496	1. system-wide app-defaults file, either locale-dependent OR global	552	1. system-wide app-defaults file, either locale-dependent OR global
497	2. app-defaults file in $XAPPLRESDIR	553	2. app-defaults file in $XAPPLRESDIR
498	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	554	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
499	4. SCREEN_RESOURCES for the current screen	555	4. SCREEN_RESOURCES for the current screen
500	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	556	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		557	6. resources specified via -xrm on the commandline
501		558
502	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
503	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
504	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
505	configured, while the class name B<URxvt> allows resources unique to	562	configured, while the class name B<URxvt> allows resources unique to
…		…
512		569
513	=over 4	570	=over 4
514		571
515	=item B<depth:> I<bitdepth>	572	=item B<depth:> I<bitdepth>
516		573
517	Compile I<frills>: Attempt to find a visual with the given bit depth;	574	Compile I<xft>: Attempt to find a visual with the given bit depth;
518	option B<-depth>.	575	option B<-depth>.
		576
		577	=item B<buffered:> I<boolean>
		578
		579	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		580	On some card/driver combination enabling it slightly decreases
		581	performance, on most it greatly helps it. The slowdown is small, so it
		582	should normally be enabled.
519		583
520	=item B<geometry:> I<geom>	584	=item B<geometry:> I<geom>
521		585
522	Create the window with the specified X window geometry [default 80x24];	586	Create the window with the specified X window geometry [default 80x24];
523	option B<-geometry>.	587	option B<-geometry>.
…		…
560	Use the specified colour to display underlined characters when the	624	Use the specified colour to display underlined characters when the
561	foreground colour is the default.	625	foreground colour is the default.
562		626
563	=item B<colorRV:> I<colour>	627	=item B<colorRV:> I<colour>
564		628
565	Use the specified colour as the background for reverse video	629	Use the specified colour as the background for reverse video characters
566	characters.	630	when OPTION_HC is disabled (--disable-frills).
567		631
568	=item B<underlineColor:> I<colour>	632	=item B<underlineColor:> I<colour>
569		633
570	If set, use the specified colour as the colour for the underline	634	If set, use the specified colour as the colour for the underline
571	itself. If unset, use the foreground colour.	635	itself. If unset, use the foreground colour.
…		…
587	option B<-rv>. B<False>: regular screen colours [default]; option	651	option B<-rv>. B<False>: regular screen colours [default]; option
588	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	652	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
589		653
590	=item B<jumpScroll:> I<boolean>	654	=item B<jumpScroll:> I<boolean>
591		655
592	B<True>: specify that jump scrolling should be used. When scrolling	656	B<True>: specify that jump scrolling should be used. When receiving lots
593	quickly, fewer screen updates are performed [default]; option B<-j>.	657	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		658	has been read, resulting in fewer updates while still displaying every
		659	received line; option B<-j>.
		660
594	B<False>: specify that smooth scrolling should be used; option B<+j>.	661	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		662	force a screen refresh on each new line it received; option B<+j>.
595		663
596	=item B<inheritPixmap:> I<boolean>	664	=item B<skipScroll:> I<boolean>
597		665
598	B<True>: make the background inherit the parent windows' pixmap, giving	666	B<True>: (the default) specify that skip scrolling should be used. When
599	artificial transparency. B<False>: do not inherit the parent windows'	667	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
600	pixmap.	668	(around 60 times per second), resulting in far fewer updates. This can
		669	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		670	option B<-ss>.
		671
		672	B<False>: specify that everything is to be displayed, even
		673	if the refresh is too fast for the human eye to read anything (or the
		674	monitor to display anything); option B<+ss>.
		675
		676	=item B<transparent:> I<boolean>
		677
		678	Turn on/off illusion of a transparent window background.
		679
		680	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		681	future versions.
		682
		683	I<Please address all transparency related issues to Sasha Vasko at
		684	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
601		685
602	=item B<fading:> I<number>	686	=item B<fading:> I<number>
603		687
604	Fade the text by the given percentage when focus is lost; option B<-fade>.	688	Fade the text by the given percentage when focus is lost; option B<-fade>.
605		689
…		…
613	Tint the transparent background pixmap with the given colour; option	697	Tint the transparent background pixmap with the given colour; option
614	B<-tint>.	698	B<-tint>.
615		699
616	=item B<shading:> I<number>	700	=item B<shading:> I<number>
617		701
618	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	702	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
619	image in addition to tinting it.	703	in addition to tinting it; option B<-sh>.
		704
		705	=item B<blendType:> I<string>
		706
		707	Specify background blending type; option B<-blt>.
		708
		709	=item B<blurRadius:> I<number>
		710
		711	Apply Gaussian Blurr with the specified radius to the transparent
		712	background image; option B<-blr>.
620		713
621	=item B<scrollColor:> I<colour>	714	=item B<scrollColor:> I<colour>
622		715
623	Use the specified colour for the scrollbar [default #B2B2B2].	716	Use the specified colour for the scrollbar [default #B2B2B2].
624		717
…		…
630	=item B<borderColor:> I<colour>	723	=item B<borderColor:> I<colour>
631		724
632	The colour of the border around the text area and between the scrollbar	725	The colour of the border around the text area and between the scrollbar
633	and the text.	726	and the text.
634		727
635	=item B<backgroundPixmap:> I<file[;geom]>	728	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
636		729
637	Use the specified XPM file (note the `.xpm' extension is optional) for	730	Use the specified image file for the background and also
638	the background and also optionally specify its scaling with a geometry	731	optionally specify its scaling with a geometry string B<WxH+X+Y>,
639	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	732	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
640	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	733	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
641	centre (percent). A scale of 0 displays the image with tiling. A scale	734	centre (percent). A scale of 0 displays the image with tiling. A scale
642	of 1 displays the image without any scaling. A scale of 2 to 9	735	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
643	specifies an integer number of images in that direction. No image will	736	an integer number of images in that direction. No image will be magnified
644	be magnified beyond 10 times its original size. The maximum permitted	737	beyond 10 times its original size. The maximum permitted scale is 1000.
645	scale is 1000. [default 0x0+50+50]	738	Additional operations can be specified after colon B<:op1:op2...>.
		739	Supported operations are:
		740
		741	tile force background image to be tiled and not scaled. Equivalent to 0x0
		742	propscale will scale image keeping proportions
		743	auto will scale image to match window size. Equivalent to 100x100
		744	hscale will scale image horizontally to the window size
		745	vscale will scale image vertically to the window size
		746	scale will scale image to match window size
		747	root will tile image as if it was a root window background, auto-adjusting
		748	whenever terminal window moves
		749
		750	If used in conjunction with B<-tr> option, the specified pixmap will be
		751	blended over transparency image using either alpha-blending, or any
		752	other blending type, specified with B<-blt "type"> option.
646		753
647	=item B<path:> I<path>	754	=item B<path:> I<path>
648		755
649	Specify the colon-delimited search path for finding XPM files.	756	Specify the colon-delimited search path for finding background image files.
650		757
651	=item B<font:> I<fontlist>	758	=item B<font:> I<fontlist>
652		759
653	Select the fonts to be used. This is a comma separated list of font names	760	Select the fonts to be used. This is a comma separated list of font names
654	that are checked in order when trying to find glyphs for characters. The	761	that are checked in order when trying to find glyphs for characters. The
…		…
711	text font will being used for the given style.	818	text font will being used for the given style.
712		819
713	=item B<intensityStyles:> I<boolean>	820	=item B<intensityStyles:> I<boolean>
714		821
715	When font styles are not enabled, or this option is enabled (B<True>,	822	When font styles are not enabled, or this option is enabled (B<True>,
716	option B<-is>, the default), bold and italic font styles imply high	823	option B<-is>, the default), bold/blink font styles imply high
717	intensity foreground/backround colours. Disabling this option (B<False>,	824	intensity foreground/background colours. Disabling this option (B<False>,
718	option B<+is>) disables this behaviour, the high intensity colours are not	825	option B<+is>) disables this behaviour, the high intensity colours are not
719	reachable.	826	reachable.
720
721	=item B<selectstyle:> I<mode>
722
723	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
724	xterm style with 2.20 old word selection, or anything else which gives
725	xterm style selection.
726
727	=item B<scrollstyle:> I<mode>
728
729	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
730	the author's favourite.
731		827
732	=item B<title:> I<string>	828	=item B<title:> I<string>
733		829
734	Set window title string, the default title is the command-line	830	Set window title string, the default title is the command-line
735	specified after the B<-e> option, if any, otherwise the application	831	specified after the B<-e> option, if any, otherwise the application
…		…
744	=item B<mapAlert:> I<boolean>	840	=item B<mapAlert:> I<boolean>
745		841
746	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	842	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
747	de-iconify (map) on receipt of a bell character [default].	843	de-iconify (map) on receipt of a bell character [default].
748		844
		845	=item B<urgentOnBell:> I<boolean>
		846
		847	B<True>: set the urgency hint for the wm on receipt of a bell character.
		848	B<False>: do not set the urgency hint [default].
		849
749	=item B<visualBell:> I<boolean>	850	=item B<visualBell:> I<boolean>
750		851
751	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	852	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
752	B<False>: no visual bell [default]; option B<+vb>.	853	B<False>: no visual bell [default]; option B<+vb>.
753		854
…		…
774	Example:	875	Example:
775		876
776	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	877	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777		878
778	This creates a new file in your home directory with the screen contents	879	This creates a new file in your home directory with the screen contents
779	everytime you hit C<Print>.	880	every time you hit C<Print>.
		881
		882	=item B<scrollstyle:> I<mode>
		883
		884	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		885	the author's favourite.
780		886
781	=item B<scrollBar:> I<boolean>	887	=item B<scrollBar:> I<boolean>
782		888
783	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	889	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
784	disable the scrollbar; option B<+sb>.	890	disable the scrollbar; option B<+sb>.
…		…
806		912
807	=item B<scrollWithBuffer:> I<boolean>	913	=item B<scrollWithBuffer:> I<boolean>
808		914
809	B<True>: scroll with scrollback buffer when tty receives new lines (and	915	B<True>: scroll with scrollback buffer when tty receives new lines (and
810	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	916	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
811	with scrollback buffer when tty recieves new lines; option B<+sw>.	917	with scrollback buffer when tty receives new lines; option B<+sw>.
812		918
813	=item B<scrollTtyKeypress:> I<boolean>	919	=item B<scrollTtyKeypress:> I<boolean>
814		920
815	B<True>: scroll to bottom when a non-special key is pressed. Special keys	921	B<True>: scroll to bottom when a non-special key is pressed. Special keys
816	are those which are intercepted by rxvt-unicode for special handling and	922	are those which are intercepted by rxvt-unicode for special handling and
…		…
847	=item B<termName:> I<termname>	953	=item B<termName:> I<termname>
848		954
849	Specifies the terminal type name to be set in the B<TERM> environment	955	Specifies the terminal type name to be set in the B<TERM> environment
850	variable; option B<-tn>.	956	variable; option B<-tn>.
851		957
852	=item B<linespace:> I<number>	958	=item B<lineSpace:> I<number>
853		959
854	Specifies number of lines (pixel height) to insert between each row of	960	Specifies number of lines (pixel height) to insert between each row of
855	the display [default 0]; option B<-lsp>.	961	the display [default 0]; option B<-lsp>.
856		962
857	=item B<meta8:> I<boolean>	963	=item B<meta8:> I<boolean>
…		…
909	=item B<cutchars:> I<string>	1015	=item B<cutchars:> I<string>
910		1016
911	The characters used as delimiters for double-click word selection	1017	The characters used as delimiters for double-click word selection
912	(whitespace delimiting is added automatically if resource is given).	1018	(whitespace delimiting is added automatically if resource is given).
913		1019
914	When the selection extension is in use (the default if compiled in, see	1020	When the perl selection extension is in use (the default if compiled
915	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1021	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
916	will be created (if the resource exists, otherwise, no regex will be	1022	characters will be created (if the resource exists, otherwise, no regex
917	created). In this mode, characters outside ISO-8859-1 can be used.	1023	will be created). In this mode, characters outside ISO-8859-1 can be used.
918		1024
919	When the selection extension is not used, only ISO-8859-1 characters can	1025	When the selection extension is not used, only ISO-8859-1 characters can
920	be used. If not specified, the built-in default is used:	1026	be used. If not specified, the built-in default is used:
921		1027
922	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1028	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
923		1029
924	=item B<preeditType:> I<style>	1030	=item B<preeditType:> I<style>
925		1031
926	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1032	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
927		1033
…		…
981		1087
982	Turn on/off secondary screen (default enabled).	1088	Turn on/off secondary screen (default enabled).
983		1089
984	=item B<secondaryScroll:> I<boolean>	1090	=item B<secondaryScroll:> I<boolean>
985		1091
986	Turn on/off secondary screen scroll (default enabled). If the this	1092	Turn on/off secondary screen scroll (default enabled). If this
987	option is enabled, scrolls on the secondary screen will change the	1093	option is enabled, scrolls on the secondary screen will change the
988	scrollback buffer and switching to/from the secondary screen will	1094	scrollback buffer and switching to/from the secondary screen will
989	instead scroll the screen up.	1095	instead scroll the screen up.
990		1096
991	=item B<hold>: I<boolean>	1097	=item B<hold>: I<boolean>
…		…
1015	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1121	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1016	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1122	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1017	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1123	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1018	performed in an exact manner; however, the closest match is assured.	1124	performed in an exact manner; however, the closest match is assured.
1019		1125
1020	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1126	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1021	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1127	number), see RESOURCES in C<man 7 X> for futher details.
1022	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1023	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1024	can start or end with whitespace.
1025
1026	Please note that you need to double the C<\> in resource files, as
1027	Xlib itself does it's own de-escaping (you can use C<\033> instead of
1028	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1029	processing).
1030		1128
1031	You can define a range of keysyms in one shot by providing a I<string>	1129	You can define a range of keysyms in one shot by providing a I<string>
1032	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1130	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1033	should be a character not used by the strings.	1131	should be a character not used by the strings.
1034		1132
1035	Its usage can be demonstrated by an example:	1133	Its usage can be demonstrated by an example:
1036		1134
1037	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1135	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1101	example, C<default,-selection> will use all the default extension except	1199	example, C<default,-selection> will use all the default extension except
1102	C<selection>.	1200	C<selection>.
1103		1201
1104	Extension names can also be followed by an argument in angle brackets	1202	Extension names can also be followed by an argument in angle brackets
1105	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1203	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1204	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1107	multiple times with different arguments will pass multiple arguments to	1205	multiple times with different arguments will pass multiple arguments to
1108	the extension.	1206	the extension.
1109		1207
1110	Each extension is looked up in the library directories, loaded if	1208	Each extension is looked up in the library directories, loaded if
1111	necessary, and bound to the current terminal instance.	1209	necessary, and bound to the current terminal instance.
…		…
1147	(default: C<M-s>).	1245	(default: C<M-s>).
1148		1246
1149	=item B<urlLauncher>: I<string>	1247	=item B<urlLauncher>: I<string>
1150		1248
1151	Specifies the program to be started with a URL argument. Used by the	1249	Specifies the program to be started with a URL argument. Used by the
1152	C<selection-popup> and C<mark-urls> perl extensions.	1250	C<selection-popup> and C<matcher> perl extensions.
1153		1251
1154	=item B<transient-for>: I<windowid>	1252	=item B<transient-for>: I<windowid>
1155		1253
1156	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1254	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157		1255
1158	=item B<override-redirect>: I<boolean>	1256	=item B<override-redirect>: I<boolean>
1159		1257
1160	Compile I<frills>: Sets override-redirect for the terminal window, making	1258	Compile I<frills>: Sets override-redirect for the terminal window, making
1161	it almost invisible to window managers; option B<-override-redirect>.	1259	it almost invisible to window managers; option B<-override-redirect>.
		1260
		1261	=item B<iso14755_52:> I<boolean>
		1262
		1263	Turn on/off ISO 14755 5.2 mode (default enabled).
1162		1264
1163	=back	1265	=back
1164		1266
1165	=head1 THE SCROLLBAR	1267	=head1 THE SCROLLBAR
1166		1268
…		…
1185	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1287	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1186	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1288	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1187	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1289	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1188	respectively.	1290	respectively.
1189		1291
1190	=head1 TEXT SELECTION AND INSERTION	1292	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1191		1293
1192	The behaviour of text selection and insertion mechanism is similar to	1294	The behaviour of text selection and insertion/pasting mechanism is similar
1193	I<xterm>(1).	1295	to I<xterm>(1).
1194		1296
1195	=over 4	1297	=over 4
1196		1298
1197	=item B<Selection>:	1299	=item B<Selecting>:
1198		1300
1199	Left click at the beginning of the region, drag to the end of the region	1301	Left click at the beginning of the region, drag to the end of the region
1200	and release; Right click to extend the marked region; Left double-click	1302	and release; Right click to extend the marked region; Left double-click
1201	to select a word; Left triple-click to select the entire logical line	1303	to select a word; Left triple-click to select the entire logical line
1202	(which can span multiple screen lines), unless modified by resource	1304	(which can span multiple screen lines), unless modified by resource
…		…
1206	(Compile: I<frills>) will create a rectangular selection instead of a	1308	(Compile: I<frills>) will create a rectangular selection instead of a
1207	normal one. In this mode, every selected row becomes its own line in the	1309	normal one. In this mode, every selected row becomes its own line in the
1208	selection, and trailing whitespace is visually underlined and removed from	1310	selection, and trailing whitespace is visually underlined and removed from
1209	the selection.	1311	the selection.
1210		1312
1211	=item B<Insertion>:	1313	=item B<Pasting>:
1212		1314
1213	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1315	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1214	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1316	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1215	Meta modifier) to be inserted as if it had been typed on the keyboard.	1317	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1216		1318
1217	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1319	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218	inserted too.	1320	inserted too.
1219		1321
1220	=back	1322	=back
…		…
1237		1339
1238	=head1 ISO 14755 SUPPORT	1340	=head1 ISO 14755 SUPPORT
1239		1341
1240	ISO 14755 is a standard for entering and viewing unicode characters	1342	ISO 14755 is a standard for entering and viewing unicode characters
1241	and character codes using the keyboard. It consists of 4 parts. The	1343	and character codes using the keyboard. It consists of 4 parts. The
1242	first part is available rxvt-unicode has been compiled with	1344	first part is available if rxvt-unicode has been compiled with
1243	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1345	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1244	with C<--enable-iso14755>.	1346	with C<--enable-iso14755>.
1245		1347
1246	=over 4	1348	=over 4
1247		1349
…		…
1267	This mode lets you input characters representing the keycap symbols of	1369	This mode lets you input characters representing the keycap symbols of
1268	your keyboard, if representable in the current locale encoding.	1370	your keyboard, if representable in the current locale encoding.
1269		1371
1270	Start by pressing C<Control> and C<Shift> together, then releasing	1372	Start by pressing C<Control> and C<Shift> together, then releasing
1271	them. The next special key (cursor keys, home etc.) you enter will not	1373	them. The next special key (cursor keys, home etc.) you enter will not
1272	invoke it's usual function but instead will insert the corresponding	1374	invoke its usual function but instead will insert the corresponding
1273	keycap symbol. The symbol will only be entered when the key has been	1375	keycap symbol. The symbol will only be entered when the key has been
1274	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1376	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1275	C<ISO Level 2 Switch>, although your intention might have been to enter a	1377	C<ISO Level 2 Switch>, although your intention might have been to enter a
1276	reverse tab (Shift-Tab).	1378	reverse tab (Shift-Tab).
1277		1379
…		…
1340	It is also possible to specify the colour values of B<foreground>,	1442	It is also possible to specify the colour values of B<foreground>,
1341	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1443	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1342	a number 0-15, as a convenient shorthand to reference the colour name of	1444	a number 0-15, as a convenient shorthand to reference the colour name of
1343	color0-color15.	1445	color0-color15.
1344		1446
1345	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1447	In addition to the colours defined above, @@RXVT_NAME@@ offers an
1346	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1448	additional 72 colours. The first 64 of those (with indices 16 to 79)
1347	(recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB>	1449	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1348	and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones	1450	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1349	provided by X, where the additional A component specifies alpha (opacity)	1451
1350	values (0 is completely transparent and the maximum is opaque). You	1452	Together, all those colours implement the 88 colour xterm colours. Only
1351	probably need to specify B<"-depth 32">, too, and have the luck that your	1453	the first 16 can be changed using resources currently, the rest can only
1352	X-server uses ARGB pixel layout, as X is far from just supporting ARGB	1454	be changed via command sequences ("escape codes").
1353	visuals out of the box, and rxvt-unicode just fudges around.
1354		1455
1355	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1456	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1356	always swapping the foreground/background colours. This is in contrast to	1457	always swapping the foreground/background colours. This is in contrast to
1357	I<xterm>(1) where the colours are only swapped if they have not otherwise	1458	I<xterm>(1) where the colours are only swapped if they have not otherwise
1358	been specified. For example,	1459	been specified. For example,
…		…
1364	would yield White on Black, while on I<xterm>(1) it would yield Black	1465	would yield White on Black, while on I<xterm>(1) it would yield Black
1365	on White.	1466	on White.
1366		1467
1367	=back	1468	=back
1368		1469
		1470	=head2 ALPHA CHANNEL SUPPORT
		1471
		1472	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1473	their act together, rxvt-unicode will do it's own alpha channel management:
		1474
		1475	You can prefix any color with an opaquenes percentage enclosed in
		1476	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1477	(0-100) that specifies the opacity of the color, where C<0> is completely
		1478	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1479	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1480	is the recommended format to specify transparency values, and works with
		1481	all ways to specify a colour.
		1482
		1483	For complete control, rxvt-unicode also supports
		1484	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1485	specifications, where the additional C<aaaa> component specifies opacity
		1486	(alpha) values. The minimum value of C<0000> is completely transparent,
		1487	while C<ffff> is completely opaque). The two example colours from
		1488	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1489	C<rgba:0000/ff00/0000/f332>.
		1490
		1491	You probably need to specify B<"-depth 32">, too, to force a visual with
		1492	alpha channels, and have the luck that your X-server uses ARGB pixel
		1493	layout, as X is far from just supporting ARGB visuals out of the box, and
		1494	rxvt-unicode just fudges around.
		1495
		1496	For example, the following selects an almost completely transparent black
		1497	background, and an almost opaque pink foreground:
		1498
		1499	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1500
		1501	When not using a background image, then the interpretation of the
		1502	alpha channel is up to your compositing manager (most interpret it as
		1503	transparency of course).
		1504
		1505	When using a background pixmap or pseudo-transparency, then the background
		1506	colour will always behave as if it were completely transparent (so the
		1507	background image shows instead), regardless of how it was specified, while
		1508	other colours will either be transparent as specified (the background
		1509	image will show through) on servers supporting the RENDER extension, or
		1510	fully opaque on servers not supporting the RENDER EXTENSION.
		1511
		1512	Please note that due to bugs in Xft, specifying alpha values might result
		1513	in garbage being displayed when the X-server does not support the RENDER
		1514	extension.
		1515
1369	=head1 ENVIRONMENT	1516	=head1 ENVIRONMENT
1370		1517
1371	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1518	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1372		1519
1373	=over 4	1520	=over 4
1374		1521
1375	=item B<TERM>	1522	=item B<TERM>
1376		1523
1377	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1524	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1378	resources or on the commandline.	1525	resources or on the command line.
1379		1526
1380	=item B<COLORTERM>	1527	=item B<COLORTERM>
1381		1528
1382	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1529	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1383	compiled with XPM support, and optionally with the added extension	1530	compiled with background image support, and optionally with the added
1384	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1531	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1532	screen.
1385		1533
1386	=item B<COLORFGBG>	1534	=item B<COLORFGBG>
1387		1535
1388	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1536	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1389	the colour code used as default foreground/text colour (or the string	1537	the colour code used as default foreground/text colour (or the string
1390	C<default> to indicate that the default-colour escape sequence is to be	1538	C<default> to indicate that the default-colour escape sequence is to be
1391	used), C<bg> is the colour code used as default background colour (or the	1539	used), C<bg> is the colour code used as default background colour (or the
1392	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1540	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1393	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1541	was compiled with background image support. Libraries like C<ncurses>
1394	(and do) use this information to optimize screen output.	1542	and C<slang> can (and do) use this information to optimize screen output.
1395		1543
1396	=item B<WINDOWID>	1544	=item B<WINDOWID>
1397		1545
1398	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1546	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1399	window, which usually has subwindows for the scrollbar, the terminal	1547	window, which usually has subwindows for the scrollbar, the terminal
…		…
1405	C<--with-terminfo=PATH>.	1553	C<--with-terminfo=PATH>.
1406		1554
1407	=item B<DISPLAY>	1555	=item B<DISPLAY>
1408		1556
1409	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1557	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1410	display in it's child processes.	1558	display in its child processes.
1411		1559
1412	=item B<SHELL>	1560	=item B<SHELL>
1413		1561
1414	The shell to be used for command execution, defaults to C</bin/sh>.	1562	The shell to be used for command execution, defaults to C</bin/sh>.
1415		1563
…		…
1457		1605
1458	=item Project Coordinator	1606	=item Project Coordinator
1459		1607
1460	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1608	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1461		1609
1462	L<http://software.schmorp.de/#rxvt-unicode>	1610	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1463		1611
1464	=back	1612	=back
1465		1613
1466	=head1 AUTHORS	1614	=head1 AUTHORS
1467		1615
…		…
1490	Project Coordinator (changes.txt 2.21a to 2.4.5)	1638	Project Coordinator (changes.txt 2.21a to 2.4.5)
1491		1639
1492	=item Geoff Wing L<< <gcw@pobox.com> >>	1640	=item Geoff Wing L<< <gcw@pobox.com> >>
1493		1641
1494	Rewrote screen display and text selection routines.	1642	Rewrote screen display and text selection routines.
1495		1643
1496	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1644	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1497		1645
1498	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1646	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1499		1647
1500	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1648	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.108 by root, Sun Jan 29 21:45:47 2006 UTC vs. Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.108 by root, Sun Jan 29 21:45:47 2006 UTC vs.
Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC