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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.106 by root, Wed Jan 25 21:03:03 2006 UTC vs.
Revision 1.157 by ayin, Sat Jan 19 16:20:09 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
103	=item B<-geometry> I<geom>	106	=item B<-geometry> I<geom>
104		107
105	Window geometry (B<-g> still respected); resource B<geometry>.	108	Window geometry (B<-g> still respected); resource B<geometry>.
…		…
108		111
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	112	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		113
111	=item B<-j>\|B<+j>	114	=item B<-j>\|B<+j>
112		115
113	Turn on/off jump scrolling; resource B<jumpScroll>.	116	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		117
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	118	=item B<-ss>\|B<+ss>
116		119
117	Turn on/off inheriting parent window's pixmap. Alternative form is	120	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.	121
		122	=item B<-tr>\|B<+tr>
		123
		124	Turn on/off illusion of a transparent window background; resource B<transparent>.
		125
		126	B<-ip> is still accepted as an obsolete alias but will be removed in
		127	future versions.
		128
		129	I<Please address all transparency related issues to Sasha Vasko at
		130	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
119		131
120	=item B<-fade> I<number>	132	=item B<-fade> I<number>
121		133
122	Fade the text by the given percentage when focus is lost. Small values	134	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	135	fade a little only, 100 completely replaces all colours by the fade
124	colour; resource B<fading>.	136	colour; resource B<fading>.
125		137
126	=item B<-fadecolor> I<colour>	138	=item B<-fadecolor> I<colour>
127		139
128	Fade to this colour when fading is used (see B<-fade>). The default colour	140	Fade to this colour when fading is used (see B<-fade>). The default colour
129	is black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
130		142
131	=item B<-tint> I<colour>	143	=item B<-tint> I<colour>
132		144
133	Tint the transparent background pixmap with the given colour when	145	Tint the transparent background pixmap with the given colour when
134	transparency is enabled with B<-tr> or B<-ip>. This only works for	146	transparency is enabled with B<-tr>. This only works for
135	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	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	148	used to brighten or darken the image in addition to tinting it.
		149	Please note that certain tint colours can be applied on the server-side,
		150	thus yielding performance gain of two orders of magnitude. These colours are:
		151	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		152	pure black and pure white colors essentially mean no tinting; resource
137	I<tintColor>. Example:	153	I<tintColor>. Example:
138		154
139	@@RXVT_NAME@@ -tr -tint blue -sh 40	155	@@RXVT_NAME@@ -tr -tint blue -sh 40
140		156
141	=item B<-sh>	157	=item B<-sh> I<number>
142		158
143	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	159	Darken (0 .. 100) or lighten (100 .. 200) the transparent
144	background image in addition to tinting it (i.e. B<-tint> must be	160	background image in addition to (or instead of) tinting it;
145	specified, too, e.g. C<-tint white>).	161	resource I<shading>.
		162
		163	=item B<-blt> I<string>
		164
		165	Specify background blending type. If background pixmap is specified
		166	at the same time as transparency - such pixmap will be blended over
		167	transparency image, using method specified. Supported values are :
		168	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		169	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		170	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		171	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		172
		173	=item B<-blr> I<HxV>
		174
		175	Apply Gaussian Blur with the specified radii to the transparent
		176	background image. If single number is specified - both vertical and
		177	horizontal radii are considered to be the same. Setting one of the
		178	radii to 1 and another to a large number creates interesting effects
		179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		180	resource I<blurRadius>.
146		181
147	=item B<-bg> I<colour>	182	=item B<-bg> I<colour>
148		183
149	Window background colour; resource B<background>.	184	Window background colour; resource B<background>.
150		185
151	=item B<-fg> I<colour>	186	=item B<-fg> I<colour>
152		187
153	Window foreground colour; resource B<foreground>.	188	Window foreground colour; resource B<foreground>.
154		189
155	=item B<-pixmap> I<file[;geom]>	190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
156		191
157	Compile I<XPM>: Specify XPM file for the background and also optionally	192	Compile I<afterimage>: Specify image file for the background and also
158	specify its scaling with a geometry string. Note you may need to	193	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	194	add quotes to avoid special shell interpretation of the C<;> in the
160	command-line; resource B<backgroundPixmap>.	195	command-line; for more details see resource B<backgroundPixmap>.
161		196
162	=item B<-cr> I<colour>	197	=item B<-cr> I<colour>
163		198
164	The cursor colour; resource B<cursorColor>.	199	The cursor colour; resource B<cursorColor>.
165		200
…		…
182	that are checked in order when trying to find glyphs for characters. The	217	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	218	first font defines the cell size for characters; other fonts might be
184	smaller, but not (in general) larger. A (hopefully) reasonable default	219	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.	220	font list is always appended to it. See resource B<font> for more details.
186		221
187	In short, to specify an X11 core font, just specify it's name or prefix it	222	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:>,	223	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
189	e.g.:	224	e.g.:
190		225
191	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	226	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	227	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
210	italic> >> characters are to be printed. See resource B<boldItalicFont>	245	italic> >> characters are to be printed. See resource B<boldItalicFont>
211	for details.	246	for details.
212		247
213	=item B<-is>\|B<+is>	248	=item B<-is>\|B<+is>
214		249
215	Compile I<font-styles>: Bold/Italic font styles imply high intensity	250	Compile I<font-styles>: Bold/Blink font styles imply high intensity
216	foreground/background (default). See resource B<intensityStyles> for	251	foreground/background (default). See resource B<intensityStyles> for
217	details.	252	details.
218		253
219	=item B<-name> I<name>	254	=item B<-name> I<name>
220		255
…		…
238		273
239	=item B<-sb>\|B<+sb>	274	=item B<-sb>\|B<+sb>
240		275
241	Turn on/off scrollbar; resource B<scrollBar>.	276	Turn on/off scrollbar; resource B<scrollBar>.
242		277
		278	=item B<-sr>\|B<+sr>
		279
		280	Put scrollbar on right/left; resource B<scrollBar_right>.
		281
		282	=item B<-st>\|B<+st>
		283
		284	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		285	resource B<scrollBar_floating>.
		286
243	=item B<-si>\|B<+si>	287	=item B<-si>\|B<+si>
244		288
245	Turn on/off scroll-to-bottom on TTY output inhibit; resource	289	Turn on/off scroll-to-bottom on TTY output inhibit; resource
246	B<scrollTtyOutput> has opposite effect.	290	B<scrollTtyOutput> has opposite effect.
247		291
…		…
253	=item B<-sw>\|B<+sw>	297	=item B<-sw>\|B<+sw>
254		298
255	Turn on/off scrolling with the scrollback buffer as new lines appear.	299	Turn on/off scrolling with the scrollback buffer as new lines appear.
256	This only takes effect if B<-si> is also given; resource	300	This only takes effect if B<-si> is also given; resource
257	B<scrollWithBuffer>.	301	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		302
268	=item B<-ptab>\|B<+ptab>	303	=item B<-ptab>\|B<+ptab>
269		304
270	If enabled (default), "Horizontal Tab" characters are being stored as	305	If enabled (default), "Horizontal Tab" characters are being stored as
271	actual wide characters in the screen buffer, which makes it possible to	306	actual wide characters in the screen buffer, which makes it possible to
…		…
318		353
319	=item B<-lsp> I<number>	354	=item B<-lsp> I<number>
320		355
321	Compile I<frills>: Lines (pixel height) to insert between each row of	356	Compile I<frills>: Lines (pixel height) to insert between each row of
322	the display. Useful to work around font rendering problems; resource	357	the display. Useful to work around font rendering problems; resource
323	B<linespace>.	358	B<lineSpace>.
324		359
325	=item B<-tn> I<termname>	360	=item B<-tn> I<termname>
326		361
327	This option specifies the name of the terminal type to be set in the	362	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	363	B<TERM> environment variable. This terminal type must exist in the
…		…
382	for more info.	417	for more info.
383		418
384	=item B<-tcw>	419	=item B<-tcw>
385		420
386	Change the meaning of triple-click selection with the left mouse	421	Change the meaning of triple-click selection with the left mouse
		422	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	423	in-use. Instead of selecting a full line it will extend the selection to
388	end of the logical line only. resource B<tripleclickwords>.	424	the end of the logical line only. resource B<tripleclickwords>.
389		425
390	=item B<-insecure>	426	=item B<-insecure>
391		427
392	Enable "insecure" mode, which currently enables most of the escape	428	Enable "insecure" mode, which currently enables most of the escape
393	sequences that echo strings. See the resource B<insecure> for more	429	sequences that echo strings. See the resource B<insecure> for more
…		…
414	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
415	will not immediately destroy its window when the program executed within	451	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	452	it exits. Instead, it will wait till it is being killed or closed by the
417	user; resource B<hold>.	453	user; resource B<hold>.
418		454
		455	=item B<-xrm> I<string>
		456
		457	Works like the X Toolkit option of the same name, by adding the I<string>
		458	as if it were specified in a resource file. Resource values specified this
		459	way take precedence over all other resource specifications.
		460
		461	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		462	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		463	options can be specified as long-options on the commandline, so use
		464	of B<-xrm> is mostly limited to cases where you want to specify other
		465	resources (e.g. for input methods) or for compatibility with other
		466	programs.
		467
419	=item B<-keysym.>I<sym> I<string>	468	=item B<-keysym.>I<sym> I<string>
420		469
421	Remap a key symbol. See resource B<keysym>.	470	Remap a key symbol. See resource B<keysym>.
422		471
423	=item B<-embed> I<windowid>	472	=item B<-embed> I<windowid>
424		473
425	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	474	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
426	which enables applications to easily embed a terminal.	475	which enables applications to easily embed a terminal.
427		476
428	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	477	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	478	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	479	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.	482	The window will not be destroyed when @@RXVT_NAME@@ exits.
434		483
435	It might be useful to know that @@RXVT_NAME@@ will not close file	484	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	485	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	486	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	487	terminal. This works regardless of whether the C<-embed> option was used or
439	not.	488	not.
440		489
441	Here is a short Gtk2-perl snippet that illustrates how this option can be	490	Here is a short Gtk2-perl snippet that illustrates how this option can be
442	used (a longer example is in F<doc/embed>):	491	used (a longer example is in F<doc/embed>):
443		492
…		…
448	});	497	});
449		498
450	=item B<-pty-fd> I<file descriptor>	499	=item B<-pty-fd> I<file descriptor>
451		500
452	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	501	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	502	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	503	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
455	without having to run a program within it.	504	without having to run a program within it.
456		505
457	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	506	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	507	entries and will not tinker with pty/tty permissions - you have to do that
459	yourself if you want that.	508	yourself if you want that.
460		509
461	As an extremely special case, specifying C<-1> will completely suppress	510	As an extremely special case, specifying C<-1> will completely suppress
462	pty/tty operations.	511	pty/tty operations, which is probably only useful in conjunction with some
		512	perl extension that manages the terminal.
463		513
464	Here is a example in perl that illustrates how this option can be used (a	514	Here is a example in perl that illustrates how this option can be used (a
465	longer example is in F<doc/pty-fd>):	515	longer example is in F<doc/pty-fd>):
466		516
467	use IO::Pty;	517	use IO::Pty;
…		…
481	Comma-separated list of perl extension scripts to use (or not to use) in	531	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.	532	this terminal instance. See resource B<perl-ext> for details.
483		533
484	=back	534	=back
485		535
486	=head1 RESOURCES (available also as long-options)	536	=head1 RESOURCES
487		537
488	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	538	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
489	options) compiled into your version.	539	options) compiled into your version. All resources are also available as
		540	long-options.
490		541
491	You can set and change the resources using X11 tools like B<xrdb>. Many	542	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	543	distribution do also load settings from the B<~/.Xresources> file when X
493	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
494	with later settings overwriting earlier ones:	545	with later settings overwriting earlier ones:
…		…
496	1. system-wide app-defaults file, either locale-dependent OR global	547	1. system-wide app-defaults file, either locale-dependent OR global
497	2. app-defaults file in $XAPPLRESDIR	548	2. app-defaults file in $XAPPLRESDIR
498	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
499	4. SCREEN_RESOURCES for the current screen	550	4. SCREEN_RESOURCES for the current screen
500	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		552	6. resources specified via -xrm on the commandline
501		553
502	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	554	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	555	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	556	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	557	configured, while the class name B<URxvt> allows resources unique to
…		…
512		564
513	=over 4	565	=over 4
514		566
515	=item B<depth:> I<bitdepth>	567	=item B<depth:> I<bitdepth>
516		568
517	Compile I<frills>: Attempt to find a visual with the given bit depth;	569	Compile I<xft>: Attempt to find a visual with the given bit depth;
518	option B<-depth>.	570	option B<-depth>.
519		571
520	=item B<geometry:> I<geom>	572	=item B<geometry:> I<geom>
521		573
522	Create the window with the specified X window geometry [default 80x24];	574	Create the window with the specified X window geometry [default 80x24];
…		…
560	Use the specified colour to display underlined characters when the	612	Use the specified colour to display underlined characters when the
561	foreground colour is the default.	613	foreground colour is the default.
562		614
563	=item B<colorRV:> I<colour>	615	=item B<colorRV:> I<colour>
564		616
565	Use the specified colour as the background for reverse video	617	Use the specified colour as the background for reverse video characters
566	characters.	618	when OPTION_HC is disabled (--disable-frills).
567		619
568	=item B<underlineColor:> I<colour>	620	=item B<underlineColor:> I<colour>
569		621
570	If set, use the specified colour as the colour for the underline	622	If set, use the specified colour as the colour for the underline
571	itself. If unset, use the foreground colour.	623	itself. If unset, use the foreground colour.
…		…
587	option B<-rv>. B<False>: regular screen colours [default]; option	639	option B<-rv>. B<False>: regular screen colours [default]; option
588	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
589		641
590	=item B<jumpScroll:> I<boolean>	642	=item B<jumpScroll:> I<boolean>
591		643
592	B<True>: specify that jump scrolling should be used. When scrolling	644	B<True>: specify that jump scrolling should be used. When receiving lots
593	quickly, fewer screen updates are performed [default]; option B<-j>.	645	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		646	has been read, resulting in fewer updates while still displaying every
		647	received line; option B<-j>.
		648
594	B<False>: specify that smooth scrolling should be used; option B<+j>.	649	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		650	force a screen refresh on each new line it received; option B<+j>.
595		651
596	=item B<inheritPixmap:> I<boolean>	652	=item B<skipScroll:> I<boolean>
597		653
598	B<True>: make the background inherit the parent windows' pixmap, giving	654	B<True>: (the default) specify that skip scrolling should be used. When
599	artificial transparency. B<False>: do not inherit the parent windows'	655	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
600	pixmap.	656	(around 60 times per second), resulting in far fewer updates. This can
		657	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		658	option B<-ss>.
		659
		660	B<False>: specify that everything is to be displayed, even
		661	if the refresh is too fast for the human eye to read anything (or the
		662	monitor to display anything); option B<+ss>.
		663
		664	=item B<transparent:> I<boolean>
		665
		666	Turn on/off illusion of a transparent window background.
		667
		668	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		669	future versions.
		670
		671	I<Please address all transparency related issues to Sasha Vasko at
		672	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
601		673
602	=item B<fading:> I<number>	674	=item B<fading:> I<number>
603		675
604	Fade the text by the given percentage when focus is lost; option B<-fade>.	676	Fade the text by the given percentage when focus is lost; option B<-fade>.
605		677
…		…
613	Tint the transparent background pixmap with the given colour; option	685	Tint the transparent background pixmap with the given colour; option
614	B<-tint>.	686	B<-tint>.
615		687
616	=item B<shading:> I<number>	688	=item B<shading:> I<number>
617		689
618	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	690	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
619	image in addition to tinting it.	691	in addition to tinting it; option B<-sh>.
		692
		693	=item B<blendType:> I<string>
		694
		695	Specify background blending type; option B<-blt>.
		696
		697	=item B<blurRadius:> I<number>
		698
		699	Apply Gaussian Blurr with the specified radius to the transparent
		700	background image; option B<-blr>.
620		701
621	=item B<scrollColor:> I<colour>	702	=item B<scrollColor:> I<colour>
622		703
623	Use the specified colour for the scrollbar [default #B2B2B2].	704	Use the specified colour for the scrollbar [default #B2B2B2].
624		705
…		…
630	=item B<borderColor:> I<colour>	711	=item B<borderColor:> I<colour>
631		712
632	The colour of the border around the text area and between the scrollbar	713	The colour of the border around the text area and between the scrollbar
633	and the text.	714	and the text.
634		715
635	=item B<backgroundPixmap:> I<file[;geom]>	716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
636		717
637	Use the specified XPM file (note the `.xpm' extension is optional) for	718	Use the specified image file for the background and also
638	the background and also optionally specify its scaling with a geometry	719	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	720	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
640	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	721	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	722	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	723	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	724	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	725	beyond 10 times its original size. The maximum permitted scale is 1000.
645	scale is 1000. [default 0x0+50+50]	726	Additional operations can be specified after colon B<:op1:op2...>.
		727	Supported operations are:
		728
		729	tile force background image to be tiled and not scaled. Equivalent to 0x0
		730	propscale will scale image keeping proportions
		731	auto will scale image to match window size. Equivalent to 100x100
		732	hscale will scale image horizontally to the window size
		733	vscale will scale image vertically to the window size
		734	scale will scale image to match window size
		735	root will tile image as if it was a root window background, auto-adjusting
		736	whenever terminal window moves
		737
		738	If used in conjunction with B<-tr> option, the specified pixmap will be
		739	blended over transparency image using either alpha-blending, or any
		740	other blending type, specified with B<-blt "type"> option.
646		741
647	=item B<path:> I<path>	742	=item B<path:> I<path>
648		743
649	Specify the colon-delimited search path for finding XPM files.	744	Specify the colon-delimited search path for finding background image files.
650		745
651	=item B<font:> I<fontlist>	746	=item B<font:> I<fontlist>
652		747
653	Select the fonts to be used. This is a comma separated list of font names	748	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	749	that are checked in order when trying to find glyphs for characters. The
…		…
711	text font will being used for the given style.	806	text font will being used for the given style.
712		807
713	=item B<intensityStyles:> I<boolean>	808	=item B<intensityStyles:> I<boolean>
714		809
715	When font styles are not enabled, or this option is enabled (B<True>,	810	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	811	option B<-is>, the default), bold/blink font styles imply high
717	intensity foreground/backround colours. Disabling this option (B<False>,	812	intensity foreground/background colours. Disabling this option (B<False>,
718	option B<+is>) disables this behaviour, the high intensity colours are not	813	option B<+is>) disables this behaviour, the high intensity colours are not
719	reachable.	814	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		815
732	=item B<title:> I<string>	816	=item B<title:> I<string>
733		817
734	Set window title string, the default title is the command-line	818	Set window title string, the default title is the command-line
735	specified after the B<-e> option, if any, otherwise the application	819	specified after the B<-e> option, if any, otherwise the application
…		…
744	=item B<mapAlert:> I<boolean>	828	=item B<mapAlert:> I<boolean>
745		829
746	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	830	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].	831	de-iconify (map) on receipt of a bell character [default].
748		832
		833	=item B<urgentOnBell:> I<boolean>
		834
		835	B<True>: set the urgency hint for the wm on receipt of a bell character.
		836	B<False>: do not set the urgency hint [default].
		837
749	=item B<visualBell:> I<boolean>	838	=item B<visualBell:> I<boolean>
750		839
751	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	840	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
752	B<False>: no visual bell [default]; option B<+vb>.	841	B<False>: no visual bell [default]; option B<+vb>.
753		842
…		…
774	Example:	863	Example:
775		864
776	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	865	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777		866
778	This creates a new file in your home directory with the screen contents	867	This creates a new file in your home directory with the screen contents
779	everytime you hit C<Print>.	868	every time you hit C<Print>.
		869
		870	=item B<scrollstyle:> I<mode>
		871
		872	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		873	the author's favourite.
780		874
781	=item B<scrollBar:> I<boolean>	875	=item B<scrollBar:> I<boolean>
782		876
783	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	877	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
784	disable the scrollbar; option B<+sb>.	878	disable the scrollbar; option B<+sb>.
…		…
806		900
807	=item B<scrollWithBuffer:> I<boolean>	901	=item B<scrollWithBuffer:> I<boolean>
808		902
809	B<True>: scroll with scrollback buffer when tty receives new lines (and	903	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	904	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
811	with scrollback buffer when tty recieves new lines; option B<+sw>.	905	with scrollback buffer when tty receives new lines; option B<+sw>.
812		906
813	=item B<scrollTtyKeypress:> I<boolean>	907	=item B<scrollTtyKeypress:> I<boolean>
814		908
815	B<True>: scroll to bottom when a non-special key is pressed. Special keys	909	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	910	are those which are intercepted by rxvt-unicode for special handling and
…		…
847	=item B<termName:> I<termname>	941	=item B<termName:> I<termname>
848		942
849	Specifies the terminal type name to be set in the B<TERM> environment	943	Specifies the terminal type name to be set in the B<TERM> environment
850	variable; option B<-tn>.	944	variable; option B<-tn>.
851		945
852	=item B<linespace:> I<number>	946	=item B<lineSpace:> I<number>
853		947
854	Specifies number of lines (pixel height) to insert between each row of	948	Specifies number of lines (pixel height) to insert between each row of
855	the display [default 0]; option B<-lsp>.	949	the display [default 0]; option B<-lsp>.
856		950
857	=item B<meta8:> I<boolean>	951	=item B<meta8:> I<boolean>
…		…
909	=item B<cutchars:> I<string>	1003	=item B<cutchars:> I<string>
910		1004
911	The characters used as delimiters for double-click word selection	1005	The characters used as delimiters for double-click word selection
912	(whitespace delimiting is added automatically if resource is given).	1006	(whitespace delimiting is added automatically if resource is given).
913		1007
914	When the selection extension is in use (the default if compiled in, see	1008	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	1009	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	1010	characters will be created (if the resource exists, otherwise, no regex
917	created). In this mode, characters outside ISO-8859-1 can be used.	1011	will be created). In this mode, characters outside ISO-8859-1 can be used.
918		1012
919	When the selection extension is not used, only ISO-8859-1 characters can	1013	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:	1014	be used. If not specified, the built-in default is used:
921		1015
922	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1016	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
923		1017
924	=item B<preeditType:> I<style>	1018	=item B<preeditType:> I<style>
925		1019
926	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1020	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
927		1021
…		…
981		1075
982	Turn on/off secondary screen (default enabled).	1076	Turn on/off secondary screen (default enabled).
983		1077
984	=item B<secondaryScroll:> I<boolean>	1078	=item B<secondaryScroll:> I<boolean>
985		1079
986	Turn on/off secondary screen scroll (default enabled). If the this	1080	Turn on/off secondary screen scroll (default enabled). If this
987	option is enabled, scrolls on the secondary screen will change the	1081	option is enabled, scrolls on the secondary screen will change the
988	scrollback buffer and switching to/from the secondary screen will	1082	scrollback buffer and switching to/from the secondary screen will
989	instead scroll the screen up.	1083	instead scroll the screen up.
990		1084
991	=item B<hold>: I<boolean>	1085	=item B<hold>: I<boolean>
…		…
1015	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1109	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	1110	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	1111	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.	1112	performed in an exact manner; however, the closest match is assured.
1019		1113
1020	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1114	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,	1115	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		1116
1031	You can define a range of keysyms in one shot by providing a I<string>	1117	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 `/'	1118	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1033	should be a character not used by the strings.	1119	should be a character not used by the strings.
1034		1120
1035	Its usage can be demonstrated by an example:	1121	Its usage can be demonstrated by an example:
1036		1122
1037	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1123	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1101	example, C<default,-selection> will use all the default extension except	1187	example, C<default,-selection> will use all the default extension except
1102	C<selection>.	1188	C<selection>.
1103		1189
1104	Extension names can also be followed by an argument in angle brackets	1190	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	1191	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1192	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1107	multiple times with different arguments will pass multiple arguments to	1193	multiple times with different arguments will pass multiple arguments to
1108	the extension.	1194	the extension.
1109		1195
1110	Each extension is looked up in the library directories, loaded if	1196	Each extension is looked up in the library directories, loaded if
1111	necessary, and bound to the current terminal instance.	1197	necessary, and bound to the current terminal instance.
…		…
1147	(default: C<M-s>).	1233	(default: C<M-s>).
1148		1234
1149	=item B<urlLauncher>: I<string>	1235	=item B<urlLauncher>: I<string>
1150		1236
1151	Specifies the program to be started with a URL argument. Used by the	1237	Specifies the program to be started with a URL argument. Used by the
1152	C<selection-popup> and C<mark-urls> perl extensions.	1238	C<selection-popup> and C<matcher> perl extensions.
1153		1239
1154	=item B<transient-for>: I<windowid>	1240	=item B<transient-for>: I<windowid>
1155		1241
1156	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1242	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157		1243
1158	=item B<override-redirect>: I<boolean>	1244	=item B<override-redirect>: I<boolean>
1159		1245
1160	Compile I<frills>: Sets override-redirect for the terminal window, making	1246	Compile I<frills>: Sets override-redirect for the terminal window, making
1161	it almost invisible to window managers; option B<-override-redirect>.	1247	it almost invisible to window managers; option B<-override-redirect>.
		1248
		1249	=item B<iso14755_52:> I<boolean>
		1250
		1251	Turn on/off ISO 14755 5.2 mode (default enabled).
1162		1252
1163	=back	1253	=back
1164		1254
1165	=head1 THE SCROLLBAR	1255	=head1 THE SCROLLBAR
1166		1256
…		…
1185	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1275	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1186	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1276	(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),	1277	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1188	respectively.	1278	respectively.
1189		1279
1190	=head1 TEXT SELECTION AND INSERTION	1280	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1191		1281
1192	The behaviour of text selection and insertion mechanism is similar to	1282	The behaviour of text selection and insertion/pasting mechanism is similar
1193	I<xterm>(1).	1283	to I<xterm>(1).
1194		1284
1195	=over 4	1285	=over 4
1196		1286
1197	=item B<Selection>:	1287	=item B<Selecting>:
1198		1288
1199	Left click at the beginning of the region, drag to the end of the region	1289	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	1290	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	1291	to select a word; Left triple-click to select the entire logical line
1202	(which can span multiple screen lines), unless modified by resource	1292	(which can span multiple screen lines), unless modified by resource
…		…
1206	(Compile: I<frills>) will create a rectangular selection instead of a	1296	(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	1297	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	1298	selection, and trailing whitespace is visually underlined and removed from
1209	the selection.	1299	the selection.
1210		1300
1211	=item B<Insertion>:	1301	=item B<Pasting>:
1212		1302
1213	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1303	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	1304	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.	1305	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1216		1306
1217	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1307	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218	inserted too.	1308	inserted too.
1219		1309
1220	=back	1310	=back
…		…
1237		1327
1238	=head1 ISO 14755 SUPPORT	1328	=head1 ISO 14755 SUPPORT
1239		1329
1240	ISO 14755 is a standard for entering and viewing unicode characters	1330	ISO 14755 is a standard for entering and viewing unicode characters
1241	and character codes using the keyboard. It consists of 4 parts. The	1331	and character codes using the keyboard. It consists of 4 parts. The
1242	first part is available rxvt-unicode has been compiled with	1332	first part is available if rxvt-unicode has been compiled with
1243	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1333	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1244	with C<--enable-iso14755>.	1334	with C<--enable-iso14755>.
1245		1335
1246	=over 4	1336	=over 4
1247		1337
…		…
1267	This mode lets you input characters representing the keycap symbols of	1357	This mode lets you input characters representing the keycap symbols of
1268	your keyboard, if representable in the current locale encoding.	1358	your keyboard, if representable in the current locale encoding.
1269		1359
1270	Start by pressing C<Control> and C<Shift> together, then releasing	1360	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	1361	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	1362	invoke its usual function but instead will insert the corresponding
1273	keycap symbol. The symbol will only be entered when the key has been	1363	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	1364	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	1365	C<ISO Level 2 Switch>, although your intention might have been to enter a
1276	reverse tab (Shift-Tab).	1366	reverse tab (Shift-Tab).
1277		1367
…		…
1310	=head1 COLORS AND GRAPHICS	1400	=head1 COLORS AND GRAPHICS
1311		1401
1312	In addition to the default foreground and background colours,	1402	In addition to the default foreground and background colours,
1313	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1403	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1314	high-intensity bold/blink versions of the same). Here is a list of the	1404	high-intensity bold/blink versions of the same). Here is a list of the
1315	colours with their B<rgb.txt> names.	1405	colours with their names.
1316		1406
1317	=begin table	1407	=begin table
1318		1408
1319	B<color0> (black) = Black	1409	B<color0> (black) = Black
1320	B<color1> (red) = Red3	1410	B<color1> (red) = Red3
…		…
1340	It is also possible to specify the colour values of B<foreground>,	1430	It is also possible to specify the colour values of B<foreground>,
1341	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1431	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	1432	a number 0-15, as a convenient shorthand to reference the colour name of
1343	color0-color15.	1433	color0-color15.
1344		1434
		1435	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1436	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1437	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1438	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1439
		1440	Together, all those colours implement the 88 colour xterm colours. Only
		1441	the first 16 can be changed using resources currently, the rest can only
		1442	be changed via command sequences ("escape codes").
		1443
1345	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1444	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1346	always swapping the foreground/background colours. This is in contrast to	1445	always swapping the foreground/background colours. This is in contrast to
1347	I<xterm>(1) where the colours are only swapped if they have not otherwise	1446	I<xterm>(1) where the colours are only swapped if they have not otherwise
1348	been specified. For example,	1447	been specified. For example,
1349		1448
…		…
1354	would yield White on Black, while on I<xterm>(1) it would yield Black	1453	would yield White on Black, while on I<xterm>(1) it would yield Black
1355	on White.	1454	on White.
1356		1455
1357	=back	1456	=back
1358		1457
		1458	=head2 ALPHA CHANNEL SUPPORT
		1459
		1460	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1461	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1462	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1463	in addition to the ones provided by X, where the additional A component
		1464	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1465	transparent). You can also prefix any color with C<[percent]>, where
		1466	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1467	the color, where C<0> is completely transparent and C<100> is completelxy
		1468	opaque.
		1469
		1470	You probably need to specify B<"-depth 32">, too, and have the luck that
		1471	your X-server uses ARGB pixel layout, as X is far from just supporting
		1472	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1473
		1474	For example, the following selects an almost completely transparent red
		1475	background, and an almost opaque pink foreground:
		1476
		1477	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1478
		1479	I<Please note that transparency of any kind if completely unsupported by
		1480	the author. Don't bug him with installation questions!>
		1481
1359	=head1 ENVIRONMENT	1482	=head1 ENVIRONMENT
1360		1483
1361	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1484	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1362		1485
1363	=over 4	1486	=over 4
1364		1487
1365	=item B<TERM>	1488	=item B<TERM>
1366		1489
1367	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1490	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1368	resources or on the commandline.	1491	resources or on the command line.
1369		1492
1370	=item B<COLORTERM>	1493	=item B<COLORTERM>
1371		1494
1372	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1495	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1373	compiled with XPM support, and optionally with the added extension	1496	compiled with background image support, and optionally with the added
1374	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1497	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1498	screen.
1375		1499
1376	=item B<COLORFGBG>	1500	=item B<COLORFGBG>
1377		1501
1378	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1502	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1379	the colour code used as default foreground/text colour (or the string	1503	the colour code used as default foreground/text colour (or the string
1380	C<default> to indicate that the default-colour escape sequence is to be	1504	C<default> to indicate that the default-colour escape sequence is to be
1381	used), C<bg> is the colour code used as default background colour (or the	1505	used), C<bg> is the colour code used as default background colour (or the
1382	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1506	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1383	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1507	was compiled with background image support. Libraries like C<ncurses>
1384	(and do) use this information to optimize screen output.	1508	and C<slang> can (and do) use this information to optimize screen output.
1385		1509
1386	=item B<WINDOWID>	1510	=item B<WINDOWID>
1387		1511
1388	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1512	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1389	window, which usually has subwindows for the scrollbar, the terminal	1513	window, which usually has subwindows for the scrollbar, the terminal
…		…
1395	C<--with-terminfo=PATH>.	1519	C<--with-terminfo=PATH>.
1396		1520
1397	=item B<DISPLAY>	1521	=item B<DISPLAY>
1398		1522
1399	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1523	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1400	display in it's child processes.	1524	display in its child processes.
1401		1525
1402	=item B<SHELL>	1526	=item B<SHELL>
1403		1527
1404	The shell to be used for command execution, defaults to C</bin/sh>.	1528	The shell to be used for command execution, defaults to C</bin/sh>.
1405		1529
…		…
1447		1571
1448	=item Project Coordinator	1572	=item Project Coordinator
1449		1573
1450	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1574	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1451		1575
1452	L<http://software.schmorp.de/#rxvt-unicode>	1576	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1453		1577
1454	=back	1578	=back
1455		1579
1456	=head1 AUTHORS	1580	=head1 AUTHORS
1457		1581
…		…
1480	Project Coordinator (changes.txt 2.21a to 2.4.5)	1604	Project Coordinator (changes.txt 2.21a to 2.4.5)
1481		1605
1482	=item Geoff Wing L<< <gcw@pobox.com> >>	1606	=item Geoff Wing L<< <gcw@pobox.com> >>
1483		1607
1484	Rewrote screen display and text selection routines.	1608	Rewrote screen display and text selection routines.
1485		1609
1486	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1610	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1487		1611
1488	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1612	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1489		1613
1490	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1614	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.106 by root, Wed Jan 25 21:03:03 2006 UTC vs. Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.106 by root, Wed Jan 25 21:03:03 2006 UTC vs.
Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC