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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.81 by root, Mon Jan 2 21:41:51 2006 UTC vs.
Revision 1.199 by sf-exg, Tue Aug 9 21:48:00 2011 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
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
		100
		101	=item B<-depth> I<bitdepth>
		102
		103	Compile I<xft>: Attempt to find a visual with the given bit depth;
		104	resource B<depth>.
		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]
97		110
98	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
99		112
100	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
101		114
…		…
103		116
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		118
106	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
107		120
108	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		122
110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
111		124
112	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>.
113	B<-tr>; resource B<inheritPixmap>.	126
		127	=item B<-tr>\|B<+tr>
		128
		129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
114		133
115	=item B<-fade> I<number>	134	=item B<-fade> I<number>
116		135
117	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
118	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	138	colour; resource B<fading>.
120		139
121	=item B<-fadecolor> I<colour>	140	=item B<-fadecolor> I<colour>
122		141
123	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
125		144
126	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
127		146
128	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	resource I<tintColor>.
130	non-tiled backgrounds, currently. See also the B<-sh> option that can be
131	used to brighten or darken the image in addition to tinting it; resource
132	I<tintColor>. Example:
133		149
134	@@RXVT_NAME@@ -tr -tint blue -sh 40	150	=item B<-sh> I<number>
135		151
136	=item B<-sh>
137
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
139	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
140	specified, too, e.g. C<-tint white>).	154
		155	=item B<-blt> I<string>
		156
		157	Specify background blending type. If background pixmap is specified
		158	at the same time as transparency - such pixmap will be blended over
		159	the transparent background, using the method specified. Supported values are:
		160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
		161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		164
		165	=item B<-blr> I<HxV>
		166
		167	Apply Gaussian Blur with the specified radii to the transparent
		168	background. If a single number is specified - both vertical and
		169	horizontal radii are considered to be the same. Setting one of the
		170	radii to 1 and another to a large number creates interesting effects
		171	on some backgrounds. Maximum radius value is 128;
		172	resource I<blurRadius>.
		173
		174	=item B<-icon> I<file>
		175
		176	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		177	is used by many window managers, taskbars and pagers to represent the
		178	application window; resource I<iconFile>.
141		179
142	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
143		181
144	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
145		183
146	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
147		185
148	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
149		187
150	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151		189
152	Compile I<XPM>: Specify XPM file for the background and also optionally	190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
153	specify its scaling with a geometry string. Note you may need to	191	optionally specify its scaling with a geometry string. Note you may need to
154	add quotes to avoid special shell interpretation of the C<;> in the	192	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
156		194
157	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
158		196
159	The cursor colour; resource B<cursorColor>.	197	The cursor colour; resource B<cursorColor>.
160		198
…		…
172	resource B<borderColor>.	210	resource B<borderColor>.
173		211
174	=item B<-fn> I<fontlist>	212	=item B<-fn> I<fontlist>
175		213
176	Select the fonts to be used. This is a comma separated list of font names	214	Select the fonts to be used. This is a comma separated list of font names
177	that are used in turn when trying to display Unicode characters. The	215	that are checked in order when trying to find glyphs for characters. The
178	first font defines the cell size for characters; other fonts might be	216	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	217	smaller, but not (in general) larger. A (hopefully) reasonable default
180	font list is always appended to it. See resource B<font> for more details.	218	font list is always appended to it. See resource B<font> for more details.
181		219
182	In short, to specify an X11 core font, just specify it's name or prefix it	220	In short, to specify an X11 core font, just specify its name or prefix it
183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	221	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	222	e.g.:
185		223
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	224	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	225	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	227	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190	section of @@RXVT_NAME@@(7).	228	section of @@RXVT_NAME@@(7).
191		229
192	=item B<-fb> I<fontlist>	230	=item B<-fb> I<fontlist>
193		231
194	Compile font-styles: The bold font list to use when bold characters are to	232	Compile I<font-styles>: The bold font list to use when B<bold> characters
195	be printed. See resource B<boldFont> for details.	233	are to be printed. See resource B<boldFont> for details.
196		234
197	=item B<-fi> I<fontlist>	235	=item B<-fi> I<fontlist>
198		236
199	Compile font-styles: The italic font list to use when bold characters are to	237	Compile I<font-styles>: The italic font list to use when I<italic>
200	be printed. See resource B<italicFont> for details.	238	characters are to be printed. See resource B<italicFont> for details.
201		239
202	=item B<-fbi> I<fontlist>	240	=item B<-fbi> I<fontlist>
203		241
204	Compile font-styles: The bold italic font list to use when bold characters are to	242	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205	be printed. See resource B<boldItalicFont> for details.	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
		244	for details.
206		245
207	=item B<-is>\|B<+is>	246	=item B<-is>\|B<+is>
208		247
209	Compile font-styles: Bold/Italic font styles imply high intensity	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
210	foreground/background (default). See resource B<intensityStyles> for	249	foreground/background (default). See resource B<intensityStyles> for
211	details.	250	details.
212		251
213	=item B<-name> I<name>	252	=item B<-name> I<name>
214		253
…		…
232		271
233	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
234		273
235	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
236		275
		276	=item B<-sr>\|B<+sr>
		277
		278	Put scrollbar on right/left; resource B<scrollBar_right>.
		279
		280	=item B<-st>\|B<+st>
		281
		282	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		283	resource B<scrollBar_floating>.
		284
237	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
238		286
239	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
240	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
241		289
…		…
247	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
248		296
249	Turn on/off scrolling with the scrollback buffer as new lines appear.	297	Turn on/off scrolling with the scrollback buffer as new lines appear.
250	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
251	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
252
253	=item B<-sr>\|B<+sr>
254
255	Put scrollbar on right/left; resource B<scrollBar_right>.
256
257	=item B<-st>\|B<+st>
258
259	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
260	resource B<scrollBar_floating>.
261		300
262	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
263		302
264	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
265	actual wide characters in the screen buffer, which makes it possible to	304	actual wide characters in the screen buffer, which makes it possible to
…		…
269		308
270	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
271		310
272	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
273		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
274	=item B<-iconic>	317	=item B<-iconic>
275		318
276	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
277	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
278		321
…		…
294		337
295	=item B<-bl>	338	=item B<-bl>
296		339
297	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	340	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
298	if honoured by the WM, the rxvt-unicode window will not have window	341	if honoured by the WM, the rxvt-unicode window will not have window
299	decorations; resource B<borderLess>.	342	decorations; resource B<borderLess>. If the window manager does not
		343	support MWM hints (e.g. kwin), enables override-redirect mode.
		344
		345	=item B<-override-redirect>
		346
		347	Compile I<frills>: Sets override-redirect on the window; resource
		348	B<override-redirect>.
		349
		350	=item B<-sbg>
		351
		352	Compile I<frills>: Disable the usage of the built-in block graphics/line
		353	drawing characters and just rely on what the specified fonts provide. Use
		354	this if you have a good font and want to use its block graphic glyphs;
		355	resource B<skipBuiltinGlyphs>.
300		356
301	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
302		358
303	Compile I<frills>: Lines (pixel height) to insert between each row of	359	Compile I<frills>: Lines (pixel height) to insert between each row of
304	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
305	B<linespace>.	361	B<lineSpace>.
		362
		363	=item B<-letsp> I<number>
		364
		365	Compile I<frills>: Amount to adjust the computed character width by
		366	to control overall letter spacing. Negative values will tighten up the
		367	letter spacing, positive values will space letters out more. Useful to
		368	work around odd font metrics; resource B<letterSpace>.
306		369
307	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
308		371
309	This option specifies the name of the terminal type to be set in the	372	This option specifies the name of the terminal type to be set in the
310	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
364	for more info.	427	for more info.
365		428
366	=item B<-tcw>	429	=item B<-tcw>
367		430
368	Change the meaning of triple-click selection with the left mouse	431	Change the meaning of triple-click selection with the left mouse
		432	button. Only effective when the original (non-perl) selection code is
369	button. Instead of selecting a full line it will extend the selection the	433	in-use. Instead of selecting a full line it will extend the selection to
370	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
371		435
372	=item B<-insecure>	436	=item B<-insecure>
373		437
374	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
375	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
396	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	460	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
397	will not immediately destroy its window when the program executed within	461	will not immediately destroy its window when the program executed within
398	it exits. Instead, it will wait till it is being killed or closed by the	462	it exits. Instead, it will wait till it is being killed or closed by the
399	user; resource B<hold>.	463	user; resource B<hold>.
400		464
		465	=item B<-cd> I<path>
		466
		467	Sets the working directory for the shell (or the command specified via
		468	B<-e>). The I<path> must be an absolute path and it must exist for
		469	@@RXVT_NAME@@ to start; resource B<chdir>.
		470
		471	=item B<-xrm> I<string>
		472
		473	Works like the X Toolkit option of the same name, by adding the I<string>
		474	as if it were specified in a resource file. Resource values specified this
		475	way take precedence over all other resource specifications.
		476
		477	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		478	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		479	options can be specified as long-options on the commandline, so use
		480	of B<-xrm> is mostly limited to cases where you want to specify other
		481	resources (e.g. for input methods) or for compatibility with other
		482	programs.
		483
401	=item B<-keysym.>I<sym> I<string>	484	=item B<-keysym.>I<sym> I<string>
402		485
403	Remap a key symbol. See resource B<keysym>.	486	Remap a key symbol. See resource B<keysym>.
404		487
405	=item B<-embed> I<windowid>	488	=item B<-embed> I<windowid>
406		489
407	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	490	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
408	which enables applications to easily embed a terminal.	491	which enables applications to easily embed a terminal.
409		492
410	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	493	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
411	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	494	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
412	quite a bit, so don't expect it to keep some specific state. It's best to	495	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
415	The window will not be destroyed when @@RXVT_NAME@@ exits.	498	The window will not be destroyed when @@RXVT_NAME@@ exits.
416		499
417	It might be useful to know that @@RXVT_NAME@@ will not close file	500	It might be useful to know that @@RXVT_NAME@@ will not close file
418	descriptors passed to it (except for stdin/out/err, of course), so you	501	descriptors passed to it (except for stdin/out/err, of course), so you
419	can use file descriptors to communicate with the programs within the	502	can use file descriptors to communicate with the programs within the
420	terminal. This works regardless of wether the C<-embed> option was used or	503	terminal. This works regardless of whether the C<-embed> option was used or
421	not.	504	not.
422		505
423	Here is a short Gtk2-perl snippet that illustrates how this option can be	506	Here is a short Gtk2-perl snippet that illustrates how this option can be
424	used (a longer example is in F<doc/embed>):	507	used (a longer example is in F<doc/embed>):
425		508
…		…
427	$rxvt->signal_connect_after (realize => sub {	510	$rxvt->signal_connect_after (realize => sub {
428	my $xid = $_[0]->window->get_xid;	511	my $xid = $_[0]->window->get_xid;
429	system "@@RXVT_NAME@@ -embed $xid &";	512	system "@@RXVT_NAME@@ -embed $xid &";
430	});	513	});
431		514
432	=item B<-pty-fd> I<fileno>	515	=item B<-pty-fd> I<file descriptor>
433		516
434	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	517	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
435	pair but instead use the given filehandle as the tty master. This is	518	pair but instead use the given file descriptor as the tty master. This is
436	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	519	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
437	without having to run a program within it.	520	without having to run a program within it.
438		521
439	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	522	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
440	entries and will not tinker with pty/tty permissions - you have to do that	523	entries and will not tinker with pty/tty permissions - you have to do that
441	yourself if you want that.	524	yourself if you want that.
		525
		526	As an extremely special case, specifying C<-1> will completely suppress
		527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
442		529
443	Here is a example in perl that illustrates how this option can be used (a	530	Here is a example in perl that illustrates how this option can be used (a
444	longer example is in F<doc/pty-fd>):	531	longer example is in F<doc/pty-fd>):
445		532
446	use IO::Pty;	533	use IO::Pty;
…		…
455	my $slave = $pty->slave;	542	my $slave = $pty->slave;
456	while (<$slave>) { print $slave "got <$_>\n" }	543	while (<$slave>) { print $slave "got <$_>\n" }
457		544
458	=item B<-pe> I<string>	545	=item B<-pe> I<string>
459		546
460	Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.	547	Comma-separated list of perl extension scripts to use (or not to use) in
		548	this terminal instance. See resource B<perl-ext> for details.
461		549
462	=back	550	=back
463		551
464	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
465		553
466	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
467	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
468		557
469	There are two different methods that @@RXVT_NAME@@ can use to get the	558	You can set and change the resources using X11 tools like B<xrdb>. Many
470	Xresource data: using the X libraries (Xrm*-functions) or internal	559	distribution do also load settings from the B<~/.Xresources> file when X
471	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
472	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	561	with later settings overwriting earlier ones:
473	resources using X11 tools like B<xrdb>. Many distribution do also load
474	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
475	will consult the following files/resources in order, with later settings
476	overwriting earlier ones:
477		562
478	1. system-wide app-defaults file, either locale-dependent OR global
479	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
480	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
481	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
482	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
483		569
484	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
485	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
486	set in XAPPLOADDIR/URxvt (compile-time defined: usually
487	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
488	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
489	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
490	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	571	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
491	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	572	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
492	easily configured, while the class name B<URxvt> allows resources	573	configured, while the class name B<URxvt> allows resources unique to
493	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	574	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
494	shared between different B<@@RXVT_NAME@@> configurations. If no	575	configurations. If no resources are specified, suitable defaults will
495	resources are specified, suitable defaults will be used. Command-line	576	be used. Command-line arguments can be used to override resource
496	arguments can be used to override resource settings. The following	577	settings. The following resources are supported (you might want to
497	resources are allowed:	578	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		579	extensions not documented here):
498		580
499	=over 4	581	=over 4
		582
		583	=item B<depth:> I<bitdepth>
		584
		585	Compile I<xft>: Attempt to find a visual with the given bit depth;
		586	option B<-depth>.
		587
		588	=item B<buffered:> I<boolean>
		589
		590	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		591	On some card/driver combination enabling it slightly decreases
		592	performance, on most it greatly helps it. The slowdown is small, so it
		593	should normally be enabled.
500		594
501	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
502		596
503	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
504	option B<-geometry>.	598	option B<-geometry>.
…		…
518	Use the specified colour for the colour value I<n>, where 0-7	612	Use the specified colour for the colour value I<n>, where 0-7
519	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
520	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
521	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	615	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
522	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	616	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
523	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
524		618
525	Colours higher than 15 cannot be set using resources (yet), but can be	619	Colours higher than 15 cannot be set using resources (yet), but can be
526	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
527		621
528	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	622	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
539	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
540		634
541	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
542	foreground colour is the default.	636	foreground colour is the default.
543		637
544	=item B<colorRV:> I<colour>
545
546	Use the specified colour as the background for reverse video
547	characters.
548
549	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
550		639
551	If set, use the specified colour as the colour for the underline	640	If set, use the specified colour as the colour for the underline
552	itself. If unset, use the foreground colour.	641	itself. If unset, use the foreground colour.
		642
		643	=item B<highlightColor:> I<colour>
		644
		645	If set, use the specified colour as the background for highlighted
		646	characters. If unset, use reverse video.
		647
		648	=item B<highlightTextColor:> I<colour>
		649
		650	If set and highlightColor is set, use the specified colour as the
		651	foreground for highlighted characters.
553		652
554	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
555		654
556	Use the specified colour for the cursor. The default is to use the	655	Use the specified colour for the cursor. The default is to use the
557	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
564		663
565	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
566		665
567	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
568	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
569	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
570		669
571	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
572		671
573	B<True>: specify that jump scrolling should be used. When scrolling	672	B<True>: specify that jump scrolling should be used. When receiving lots
574	quickly, fewer screen updates are performed [default]; option B<-j>.	673	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		674	has been read, resulting in fewer updates while still displaying every
		675	received line; option B<-j>.
		676
575	B<False>: specify that smooth scrolling should be used; option B<+j>.	677	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		678	force a screen refresh on each new line it received; option B<+j>.
576		679
577	=item B<inheritPixmap:> I<boolean>	680	=item B<skipScroll:> I<boolean>
578		681
579	B<True>: make the background inherit the parent windows' pixmap, giving	682	B<True>: (the default) specify that skip scrolling should be used. When
580	artificial transparency. B<False>: do not inherit the parent windows'	683	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
581	pixmap.	684	(around 60 times per second), resulting in far fewer updates. This can
		685	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		686	option B<-ss>.
		687
		688	B<False>: specify that everything is to be displayed, even
		689	if the refresh is too fast for the human eye to read anything (or the
		690	monitor to display anything); option B<+ss>.
		691
		692	=item B<transparent:> I<boolean>
		693
		694	Turn on/off pseudo-transparency by using the root pixmap as background.
		695
		696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		697	future versions.
582		698
583	=item B<fading:> I<number>	699	=item B<fading:> I<number>
584		700
585	Fade the text by the given percentage when focus is lost; option B<-fade>.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
586		702
…		…
589	Fade to this colour, when fading is used (see B<fading:>). The default	705	Fade to this colour, when fading is used (see B<fading:>). The default
590	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
591		707
592	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
593		709
594	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
595	B<-tint>.	711	extension is not available only black, red, green, yellow, blue,
		712	magenta, cyan and white tints can be performed server-side. Note that
		713	a black tint yields a completely black image while a white tint yields
		714	the image unchanged; option B<-tint>.
596		715
597	=item B<shading:> I<number>	716	=item B<shading:> I<number>
598		717
599	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
600	image in addition to tinting it.	719	A value of 100 means no shading; option B<-sh>.
		720
		721	=item B<blendType:> I<string>
		722
		723	Specify background blending type; option B<-blt>.
		724
		725	=item B<blurRadius:> I<number>
		726
		727	Apply gaussian blur with the specified radius to the transparent
		728	background; option B<-blr>.
		729
		730	=item B<iconFile:> I<file>
		731
		732	Set the application icon pixmap; option B<-icon>.
601		733
602	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
603		735
604	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
605		737
…		…
611	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
612		744
613	The colour of the border around the text area and between the scrollbar	745	The colour of the border around the text area and between the scrollbar
614	and the text.	746	and the text.
615		747
616	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
617		749
618	Use the specified XPM file (note the `.xpm' extension is optional) for	750	Use the specified image file for the background and also
619	the background and also optionally specify its scaling with a geometry	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
620	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	752	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
621	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
622	centre (percent). A scale of 0 displays the image with tiling. A scale	754	centre (percent). A scale of 0 disables scaling.
623	of 1 displays the image without any scaling. A scale of 2 to 9	755	The maximum permitted scale is 1000.
624	specifies an integer number of images in that direction. No image will	756	Additional operations can be specified after colon B<:op1:op2...>.
625	be magnified beyond 10 times its original size. The maximum permitted	757	Supported operations are:
626	scale is 1000. [default 0x0+50+50]
627		758
628	=item B<menu:> I<file[;tag]>	759	tile will tile image
		760	propscale will scale image keeping proportions
		761	hscale will scale image horizontally to the window size
		762	vscale will scale image vertically to the window size
		763	scale will scale image to match window size
		764	root will tile image as if it was a root window background, auto-adjusting
		765	whenever terminal window moves
629		766
630	Read in the specified menu file (note the `.menu' extension is	767	If used in conjunction with B<-tr> option, the specified pixmap will be
631	optional) and also optionally specify a starting tag to find. See the	768	blended over the transparent background using alpha-blending. If I<afterimage>
632	reference documentation for details on the syntax for the menuBar.	769	support has been compiled in it is possible to choose other blending
		770	types with B<-blt "type"> option.
633		771
634	=item B<path:> I<path>	772	=item B<path:> I<path>
635		773
636	Specify the colon-delimited search path for finding files (XPM and	774	Specify the colon-delimited search path for finding background image files.
637	menus), in addition to the paths specified by the B<RXVTPATH> and
638	B<PATH> environment variables.
639		775
640	=item B<font:> I<fontlist>	776	=item B<font:> I<fontlist>
641		777
642	Select the fonts to be used. This is a comma separated list of font	778	Select the fonts to be used. This is a comma separated list of font names
643	names that are used in turn when trying to display Unicode characters.	779	that are checked in order when trying to find glyphs for characters. The
644	The first font defines the cell size for characters; other fonts might	780	first font defines the cell size for characters; other fonts might be
645	be smaller, but not larger. A reasonable default font list is always	781	smaller, but not (in general) larger. A (hopefully) reasonable default
646	appended to it; option B<-fn>.	782	font list is always appended to it; option B<-fn>.
647		783
648	Each font can either be a standard X11 core font (XLFD) name, with	784	Each font can either be a standard X11 core font (XLFD) name, with
649	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	785	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
650		786
651	In addition, each font can be prefixed with additional hints and	787	In addition, each font can be prefixed with additional hints and
…		…
653	hint currently is C<codeset=codeset-name>, and this is only used for Xft	789	hint currently is C<codeset=codeset-name>, and this is only used for Xft
654	fonts.	790	fonts.
655		791
656	For example, this font resource	792	For example, this font resource
657		793
658	URxvt*font: 9x15bold,\	794	URxvt.font: 9x15bold,\
659	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	795	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
660	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	796	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
661	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	797	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
662	xft:Code2000:antialias=false	798	xft:Code2000:antialias=false
663		799
…		…
666	it is named first) and thus defines the character cell grid to be 9 pixels	802	it is named first) and thus defines the character cell grid to be 9 pixels
667	wide and 15 pixels high.	803	wide and 15 pixels high.
668		804
669	The second font is just used to add additional unicode characters not in	805	The second font is just used to add additional unicode characters not in
670	the base font, likewise the third, which is unfortunately non-bold, but	806	the base font, likewise the third, which is unfortunately non-bold, but
671	the bold version of the font does contain less characters, so this is a	807	the bold version of the font does contain fewer characters, so this is a
672	useful supplement.	808	useful supplement.
673		809
674	The third font is an Xft font with aliasing turned off, and the characters	810	The third font is an Xft font with aliasing turned off, and the characters
675	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	811	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
676	contains other characters, but we are not interested in them.	812	contains other characters, but we are not interested in them.
…		…
700	text font will being used for the given style.	836	text font will being used for the given style.
701		837
702	=item B<intensityStyles:> I<boolean>	838	=item B<intensityStyles:> I<boolean>
703		839
704	When font styles are not enabled, or this option is enabled (B<True>,	840	When font styles are not enabled, or this option is enabled (B<True>,
705	option B<-is>, the default), bold and italic font styles imply high	841	option B<-is>, the default), bold/blink font styles imply high
706	intensity foreground/backround colours. Disabling this option (B<False>,	842	intensity foreground/background colours. Disabling this option (B<False>,
707	option B<+is>) disables this behaviour, the high intensity colours are not	843	option B<+is>) disables this behaviour, the high intensity colours are not
708	reachable.	844	reachable.
709
710	=item B<selectstyle:> I<mode>
711
712	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
713	xterm style with 2.20 old word selection, or anything else which gives
714	xterm style selection.
715
716	=item B<scrollstyle:> I<mode>
717
718	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
719	the author's favourite.
720		845
721	=item B<title:> I<string>	846	=item B<title:> I<string>
722		847
723	Set window title string, the default title is the command-line	848	Set window title string, the default title is the command-line
724	specified after the B<-e> option, if any, otherwise the application	849	specified after the B<-e> option, if any, otherwise the application
…		…
733	=item B<mapAlert:> I<boolean>	858	=item B<mapAlert:> I<boolean>
734		859
735	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	860	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
736	de-iconify (map) on receipt of a bell character [default].	861	de-iconify (map) on receipt of a bell character [default].
737		862
		863	=item B<urgentOnBell:> I<boolean>
		864
		865	B<True>: set the urgency hint for the wm on receipt of a bell character.
		866	B<False>: do not set the urgency hint [default].
		867
		868	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		869
738	=item B<visualBell:> I<boolean>	870	=item B<visualBell:> I<boolean>
739		871
740	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	872	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
741	B<False>: no visual bell [default]; option B<+vb>.	873	B<False>: no visual bell [default]; option B<+vb>.
742		874
…		…
760		892
761	The string will be interpreted as if typed into the shell as-is.	893	The string will be interpreted as if typed into the shell as-is.
762		894
763	Example:	895	Example:
764		896
765	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	897	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
766		898
767	This creates a new file in your home directory with the screen contents	899	This creates a new file in your home directory with the screen contents
768	everytime you hit C<Print>.	900	every time you hit C<Print>.
		901
		902	=item B<scrollstyle:> I<mode>
		903
		904	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		905	the author's favourite.
		906
		907	=item B<thickness:> I<number>
		908
		909	Set the scrollbar width in pixels.
769		910
770	=item B<scrollBar:> I<boolean>	911	=item B<scrollBar:> I<boolean>
771		912
772	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	913	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
773	disable the scrollbar; option B<+sb>.	914	disable the scrollbar; option B<+sb>.
…		…
793	B<False>: do not scroll to bottom when tty receives output; option	934	B<False>: do not scroll to bottom when tty receives output; option
794	B<+si>.	935	B<+si>.
795		936
796	=item B<scrollWithBuffer:> I<boolean>	937	=item B<scrollWithBuffer:> I<boolean>
797		938
798	B<True>: scroll with scrollback buffer when tty receives new lines (and	939	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
799	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	940	try to show the same lines) and B<scrollTtyOutput> is False; option
800	with scrollback buffer when tty recieves new lines; option B<+sw>.	941	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		942	new lines; option B<+sw>.
801		943
802	=item B<scrollTtyKeypress:> I<boolean>	944	=item B<scrollTtyKeypress:> I<boolean>
803		945
804	B<True>: scroll to bottom when a non-special key is pressed. Special keys	946	B<True>: scroll to bottom when a non-special key is pressed. Special keys
805	are those which are intercepted by rxvt-unicode for special handling and	947	are those which are intercepted by rxvt-unicode for special handling and
…		…
824	=item B<borderLess:> I<boolean>	966	=item B<borderLess:> I<boolean>
825		967
826	Set MWM hints to request a borderless window, i.e. if honoured by the	968	Set MWM hints to request a borderless window, i.e. if honoured by the
827	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	969	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
828		970
		971	=item B<skipBuiltinGlyphs:> I<boolean>
		972
		973	Compile I<frills>: Disable the usage of the built-in block graphics/line
		974	drawing characters and just rely on what the specified fonts provide. Use
		975	this if you have a good font and want to use its block graphic glyphs;
		976	option B<-sbg>.
		977
829	=item B<termName:> I<termname>	978	=item B<termName:> I<termname>
830		979
831	Specifies the terminal type name to be set in the B<TERM> environment	980	Specifies the terminal type name to be set in the B<TERM> environment
832	variable; option B<-tn>.	981	variable; option B<-tn>.
833		982
834	=item B<linespace:> I<number>	983	=item B<lineSpace:> I<number>
835		984
836	Specifies number of lines (pixel height) to insert between each row of	985	Specifies number of lines (pixel height) to insert between each row of
837	the display [default 0]; option B<-lsp>.	986	the display [default 0]; option B<-lsp>.
838		987
839	=item B<meta8:> I<boolean>	988	=item B<meta8:> I<boolean>
…		…
853		1002
854	=item B<cursorBlink:> I<boolean>	1003	=item B<cursorBlink:> I<boolean>
855		1004
856	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1005	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
857	option B<-bc>.	1006	option B<-bc>.
		1007
		1008	=item B<cursorUnderline:> I<boolean>
		1009
		1010	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1011	option B<-uc>.
858		1012
859	=item B<pointerBlank:> I<boolean>	1013	=item B<pointerBlank:> I<boolean>
860		1014
861	B<True>: blank the pointer when a key is pressed or after a set number	1015	B<True>: blank the pointer when a key is pressed or after a set number
862	of seconds of inactivity. B<False>: the pointer is always visible	1016	of seconds of inactivity. B<False>: the pointer is always visible
…		…
876	large number (e.g. C<987654321>) to effectively disable the timeout.	1030	large number (e.g. C<987654321>) to effectively disable the timeout.
877		1031
878	=item B<backspacekey:> I<string>	1032	=item B<backspacekey:> I<string>
879		1033
880	The string to send when the backspace key is pressed. If set to B<DEC>	1034	The string to send when the backspace key is pressed. If set to B<DEC>
881	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1035	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
882	(code 8) - which can be reversed with the appropriate DEC private mode	1036	(code 8) - which can be reversed with the appropriate DEC private mode
883	escape sequence.	1037	escape sequence.
884		1038
885	=item B<deletekey:> I<string>	1039	=item B<deletekey:> I<string>
886		1040
…		…
888	pressed. If unset it will send the sequence traditionally associated	1042	pressed. If unset it will send the sequence traditionally associated
889	with the B<Execute> key.	1043	with the B<Execute> key.
890		1044
891	=item B<cutchars:> I<string>	1045	=item B<cutchars:> I<string>
892		1046
893	The characters used as delimiters for double-click word selection. The	1047	The characters used as delimiters for double-click word selection
894	built-in default:	1048	(whitespace delimiting is added automatically if resource is given).
895		1049
		1050	When the perl selection extension is in use (the default if compiled
		1051	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1052	characters will be created (if the resource exists, otherwise, no regex
		1053	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1054
		1055	When the selection extension is not used, only ISO-8859-1 characters can
		1056	be used. If not specified, the built-in default is used:
		1057
896	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1058	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
897		1059
898	=item B<preeditType:> I<style>	1060	=item B<preeditType:> I<style>
899		1061
900	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1062	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
901		1063
…		…
935	default. (Note that many other terminals, including xterm, have these	1097	default. (Note that many other terminals, including xterm, have these
936	sequences enabled by default, which doesn't make it safer, though).	1098	sequences enabled by default, which doesn't make it safer, though).
937		1099
938	You can enable them by setting this boolean resource or specifying	1100	You can enable them by setting this boolean resource or specifying
939	B<-insecure> as an option. At the moment, this enables display-answer,	1101	B<-insecure> as an option. At the moment, this enables display-answer,
940	locale, findfont, icon label and window title requests as well as dynamic	1102	locale, findfont, icon label and window title requests.
941	menubar dispatch.
942		1103
943	=item B<modifier:> I<modifier>	1104	=item B<modifier:> I<modifier>
944		1105
945	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1106	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
946	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1107	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
950		1111
951	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1112	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
952	character is passed through. It may contain escape values as described	1113	character is passed through. It may contain escape values as described
953	in the entry on B<keysym> following.	1114	in the entry on B<keysym> following.
954		1115
955	=item B<secondaryScreen:> I<bool>	1116	=item B<secondaryScreen:> I<boolean>
956		1117
957	Turn on/off secondary screen (default enabled).	1118	Turn on/off secondary screen (default enabled).
958		1119
959	=item B<secondaryScroll:> I<bool>	1120	=item B<secondaryScroll:> I<boolean>
960		1121
961	Turn on/off secondary screen scroll (default enabled). If the this	1122	Turn on/off secondary screen scroll (default enabled). If this
962	option is enabled, scrolls on the secondary screen will change the	1123	option is enabled, scrolls on the secondary screen will change the
963	scrollback buffer and switching to/from the secondary screen will	1124	scrollback buffer and, when secondaryScreen is off, switching
964	instead scroll the screen up.	1125	to/from the secondary screen will instead scroll the screen up.
965		1126
966	=item B<hold>: I<bool>	1127	=item B<hold>: I<boolean>
967		1128
968	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1129	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
969	will not immediately destroy its window when the program executed within	1130	will not immediately destroy its window when the program executed within
970	it exits. Instead, it will wait till it is being killed or closed by the	1131	it exits. Instead, it will wait till it is being killed or closed by the
971	user.	1132	user.
		1133
		1134	=item B<chdir>: I<path>
		1135
		1136	Sets the working directory for the shell (or the command specified via
		1137	B<-e>). The I<path> must be an absolute path and it must exist for
		1138	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1139	directory will be used; option B<-cd>.
972		1140
973	=item B<keysym.>I<sym>: I<string>	1141	=item B<keysym.>I<sym>: I<string>
974		1142
975	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1143	Compile I<frills>: Associate I<string> with keysym I<sym>. The
976	intervening resource name B<keysym.> cannot be omitted.	1144	intervening resource name B<keysym.> cannot be omitted.
…		…
990	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1158	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
991	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1159	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
992	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1160	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
993	performed in an exact manner; however, the closest match is assured.	1161	performed in an exact manner; however, the closest match is assured.
994		1162
995	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1163	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
996	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1164	number), see RESOURCES in C<man 7 X> for further details.
997	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
998	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
999	can start or end with whitespace.
1000
1001	Please note that you need to double the C<\> when using
1002	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1003	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1004	@@RXVT_NAME@@'s own processing).
1005		1165
1006	You can define a range of keysyms in one shot by providing a I<string>	1166	You can define a range of keysyms in one shot by providing a I<string>
1007	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1167	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1008	should be a character not used by the strings.	1168	should be a character not used by the strings.
1009		1169
1010	Its usage can be demonstrated by an example:	1170	Its usage can be demonstrated by an example:
1011		1171
1012	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1172	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1013		1173
1014	The above line is equivalent to the following three lines:	1174	The above line is equivalent to the following three lines:
1015		1175
1016	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1176	URxvt.keysym.Meta-Control-0x61: \033<a>
1017	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1177	URxvt.keysym.Meta-Control-0x62: \033<b>
1018	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1178	URxvt.keysym.Meta-Control-0x63: \033<c>
1019		1179
1020	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1180	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1021	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1181	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1022	example the following means "change the current locale to C<zh_CN.GBK>	1182	example the following means "change the current locale to C<zh_CN.GBK>
1023	when Control-Meta-c is being pressed":	1183	when Control-Meta-c is being pressed":
1024		1184
1025	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1185	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1026		1186
1027	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1187	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1028	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1188	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1029	manpage. For example, the F<selection> extension (activated via	1189	manpage. For example, the F<selection> extension (activated via
1030	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1190	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1031		1191
1032	URxvt.keysym.M-C-c: perl:selection:rot13	1192	URxvt.keysym.M-C-c: perl:selection:rot13
1033		1193
1034	Due the the large number of modifier combinations, a defined key mapping	1194	Due the the large number of modifier combinations, a defined key mapping
1035	will match if at I<at least> the specified identifiers are being set, and	1195	will match if I<at least> the specified identifiers are being set, and
1036	no other key mappings with those and more bits are being defined. That	1196	no other key mappings with those and more bits are being defined. That
1037	means that defining a key map for C<a> will automatically provide	1197	means that defining a key map for C<a> will automatically provide
1038	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1198	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1039	mappings themselves.	1199	mappings themselves.
1040		1200
…		…
1061	info):	1221	info):
1062		1222
1063	URxvt.keysym.M-C-3: command:\033[8;25;80t	1223	URxvt.keysym.M-C-3: command:\033[8;25;80t
1064	URxvt.keysym.M-C-4: command:\033[8;48;110t	1224	URxvt.keysym.M-C-4: command:\033[8;48;110t
1065		1225
		1226	=item B<perl-ext-common>: I<string>
		1227
1066	=item B<perl-ext>: I<string>	1228	=item B<perl-ext>: I<string>
1067		1229
1068	Colon-separated list of perl extension scripts to use in this terminal	1230	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1231	use in this terminal instance; option B<-pe>.
		1232
		1233	Extension names can be prefixed with a C<-> sign to prohibit using
		1234	them. This can be useful to selectively disable some extensions loaded
		1235	by default, or specified via the C<perl-ext-common> resource. For
		1236	example, C<default,-selection> will use all the default extension except
		1237	C<selection>.
		1238
		1239	Extension names can also be followed by an argument in angle brackets
		1240	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1241	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1242	multiple times with different arguments will pass multiple arguments to
		1243	the extension.
		1244
1069	instance. Each extension is looked up in the library directories, loaded	1245	Each extension is looked up in the library directories, loaded if
1070	if necessary, and bound to the current terminal instance; option B<-pe>.	1246	necessary, and bound to the current terminal instance.
		1247
		1248	If both of these resources are the empty string, then the perl
		1249	interpreter will not be initialized. The idea behind two options is that
		1250	B<perl-ext-common> will be used for extensions that should be available to
		1251	all instances, while B<perl-ext> is used for specific instances.
1071		1252
1072	=item B<perl-eval>: I<string>	1253	=item B<perl-eval>: I<string>
1073		1254
1074	Perl code to be evaluated when all extensions have been registered. See the	1255	Perl code to be evaluated when all extensions have been registered. See
1075	@@RXVT_NAME@@perl(3) manpage.	1256	the @@RXVT_NAME@@perl(3) manpage.
1076		1257
1077	=item B<perl-lib>: I<path>	1258	=item B<perl-lib>: I<path>
1078		1259
1079	Colon-separated list of additional directories that hold extension	1260	Colon-separated list of additional directories that hold extension
1080	scripts. When looking for extensions specified by the C<perl> resource,	1261	scripts. When looking for extensions specified by the C<perl> resource,
1081	@@RXVT_NAME@@ will first look in these directories and then in	1262	@@RXVT_NAME@@ will first look in these directories and then in
1082	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1263	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1083		1264
1084	See the @@RXVT_NAME@@perl(3) manpage.	1265	See the @@RXVT_NAME@@perl(3) manpage.
		1266
		1267	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1268
		1269	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1270	details.
		1271
		1272	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1273
		1274	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1275	for details.
		1276
		1277	=item B<searchable-scrollback:> I<keysym>
		1278
		1279	Sets the hotkey that starts the incremental scrollback buffer search
		1280	(default: C<M-s>).
		1281
		1282	=item B<urlLauncher>: I<string>
		1283
		1284	Specifies the program to be started with a URL argument. Used by the
		1285	C<selection-popup> and C<matcher> perl extensions.
		1286
		1287	=item B<transient-for>: I<windowid>
		1288
		1289	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1290
		1291	=item B<override-redirect>: I<boolean>
		1292
		1293	Compile I<frills>: Sets override-redirect for the terminal window, making
		1294	it almost invisible to window managers; option B<-override-redirect>.
		1295
		1296	=item B<iso14755:> I<boolean>
		1297
		1298	Turn on/off ISO 14755 (default enabled).
		1299
		1300	=item B<iso14755_52:> I<boolean>
		1301
		1302	Turn on/off ISO 14755 5.2 mode (default enabled).
1085		1303
1086	=back	1304	=back
1087		1305
1088	=head1 THE SCROLLBAR	1306	=head1 THE SCROLLBAR
1089		1307
…		…
1108	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1326	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1109	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1327	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1110	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1328	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1111	respectively.	1329	respectively.
1112		1330
1113	=head1 TEXT SELECTION AND INSERTION	1331	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1114		1332
1115	The behaviour of text selection and insertion mechanism is similar to	1333	The behaviour of text selection and insertion/pasting mechanism is similar
1116	I<xterm>(1).	1334	to I<xterm>(1).
1117		1335
1118	=over 4	1336	=over 4
1119		1337
1120	=item B<Selection>:	1338	=item B<Selecting>:
1121		1339
1122	Left click at the beginning of the region, drag to the end of the region	1340	Left click at the beginning of the region, drag to the end of the region
1123	and release; Right click to extend the marked region; Left double-click	1341	and release; Right click to extend the marked region; Left double-click
1124	to select a word; Left triple-click to select the entire logical line	1342	to select a word; Left triple-click to select the entire logical line
1125	(which can span multiple screen lines), unless modified by resource	1343	(which can span multiple screen lines), unless modified by resource
…		…
1129	(Compile: I<frills>) will create a rectangular selection instead of a	1347	(Compile: I<frills>) will create a rectangular selection instead of a
1130	normal one. In this mode, every selected row becomes its own line in the	1348	normal one. In this mode, every selected row becomes its own line in the
1131	selection, and trailing whitespace is visually underlined and removed from	1349	selection, and trailing whitespace is visually underlined and removed from
1132	the selection.	1350	the selection.
1133		1351
1134	=item B<Insertion>:	1352	=item B<Pasting>:
1135		1353
1136	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1354	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1137	an B<@@RXVT_NAME@@> window causes the current text selection to be	1355	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1138	inserted as if it had been typed on the keyboard.	1356	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1357
		1358	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1359	inserted too.
1139		1360
1140	=back	1361	=back
1141		1362
1142	=head1 CHANGING FONTS	1363	=head1 CHANGING FONTS
1143		1364
1144	Changing fonts (or font sizes, respectively) via the keypad is not yet	1365	Changing fonts (or font sizes, respectively) via the keypad is not yet
1145	supported in rxvt-unicode. Bug me if you need this.	1366	supported in rxvt-unicode. Bug me if you need this.
1146		1367
1147	You can, however, switch fonts at runtime using escape sequences (and	1368	You can, however, switch fonts at runtime using escape sequences, e.g.:
1148	therefore using the menubar), e.g.:
1149		1369
1150	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1370	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1371
		1372	You can use keyboard shortcuts, too:
		1373
		1374	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1375	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1151		1376
1152	rxvt-unicode will automatically re-apply these fonts to the output so far.	1377	rxvt-unicode will automatically re-apply these fonts to the output so far.
1153		1378
1154	=head1 ISO 14755 SUPPORT	1379	=head1 ISO 14755 SUPPORT
1155		1380
1156	ISO 14755 is a standard for entering and viewing unicode characters	1381	ISO 14755 is a standard for entering and viewing unicode characters
1157	and character codes using the keyboard. It consists of 4 parts. The	1382	and character codes using the keyboard. It consists of 4 parts. The
1158	first part is available rxvt-unicode has been compiled with	1383	first part is available if rxvt-unicode has been compiled with
1159	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1384	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1160	with C<--enable-iso14755>.	1385	with C<--enable-iso14755>.
1161		1386
1162	=over 4	1387	=over 4
1163		1388
…		…
1183	This mode lets you input characters representing the keycap symbols of	1408	This mode lets you input characters representing the keycap symbols of
1184	your keyboard, if representable in the current locale encoding.	1409	your keyboard, if representable in the current locale encoding.
1185		1410
1186	Start by pressing C<Control> and C<Shift> together, then releasing	1411	Start by pressing C<Control> and C<Shift> together, then releasing
1187	them. The next special key (cursor keys, home etc.) you enter will not	1412	them. The next special key (cursor keys, home etc.) you enter will not
1188	invoke it's usual function but instead will insert the corresponding	1413	invoke its usual function but instead will insert the corresponding
1189	keycap symbol. The symbol will only be entered when the key has been	1414	keycap symbol. The symbol will only be entered when the key has been
1190	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1415	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1191	C<ISO Level 2 Switch>, although your intention might have been to enter a	1416	C<ISO Level 2 Switch>, although your intention might have been to enter a
1192	reverse tab (Shift-Tab).	1417	reverse tab (Shift-Tab).
1193		1418
…		…
1221	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1446	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1222	it can be seen via the I<who(1)> command, and can accept messages. To	1447	it can be seen via the I<who(1)> command, and can accept messages. To
1223	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1448	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1224	on some systems or setgid to root or to some other group on others.	1449	on some systems or setgid to root or to some other group on others.
1225		1450
1226	=head1 COLORS AND GRAPHICS	1451	=head1 COLOURS AND GRAPHICS
1227		1452
1228	In addition to the default foreground and background colours,	1453	In addition to the default foreground and background colours,
1229	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1454	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1230	high-intensity bold/blink versions of the same). Here is a list of the	1455	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1231	colours with their B<rgb.txt> names.	1456	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1457	cube plus a 8 (24) colour greyscale ramp.
		1458
		1459	Here is a list of the ANSI colours with their names.
1232		1460
1233	=begin table	1461	=begin table
1234		1462
1235	B<color0> (black) = Black	1463	B<color0> (black) = Black
1236	B<color1> (red) = Red3	1464	B<color1> (red) = Red3
…		…
1256	It is also possible to specify the colour values of B<foreground>,	1484	It is also possible to specify the colour values of B<foreground>,
1257	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1485	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1258	a number 0-15, as a convenient shorthand to reference the colour name of	1486	a number 0-15, as a convenient shorthand to reference the colour name of
1259	color0-color15.	1487	color0-color15.
1260		1488
		1489	The following text gives values for the standard 88 colour mode (and
		1490	values for the 256 colour mode in parentheses).
		1491
		1492	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1493
		1494	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1495	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1496
		1497	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1498	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1499	the RGB cube.
		1500
		1501	Together, all those colours implement the 88 (256) colour xterm
		1502	colours. Only the first 16 can be changed using resources currently, the
		1503	rest can only be changed via command sequences ("escape codes").
		1504
		1505	Applications are advised to use terminfo or command sequences to discover
		1506	number and RGB values of all colours (yes, you can query this...).
		1507
1261	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1508	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1262	always swapping the foreground/background colours. This is in contrast to	1509	always swapping the foreground/background colours. This is in contrast to
1263	I<xterm>(1) where the colours are only swapped if they have not otherwise	1510	I<xterm>(1) where the colours are only swapped if they have not otherwise
1264	been specified. For example,	1511	been specified. For example,
1265		1512
		1513	@@RXVT_NAME@@ -fg Black -bg White -rv
		1514
		1515	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1516	White.
		1517
		1518	=head2 ALPHA CHANNEL SUPPORT
		1519
		1520	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1521	their act together, rxvt-unicode will do it's own alpha channel management:
		1522
		1523	You can prefix any colour with an opaqueness percentage enclosed in
		1524	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1525	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1526	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1527	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1528	is the recommended format to specify transparency values, and works with
		1529	all ways to specify a colour.
		1530
		1531	For complete control, rxvt-unicode also supports
		1532	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1533	specifications, where the additional C<aaaa> component specifies opacity
		1534	(alpha) values. The minimum value of C<0000> is completely transparent,
		1535	while C<ffff> is completely opaque). The two example colours from
		1536	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1537	C<rgba:0000/ff00/0000/f332>.
		1538
		1539	You probably need to specify B<"-depth 32">, too, to force a visual with
		1540	alpha channels, and have the luck that your X-server uses ARGB pixel
		1541	layout, as X is far from just supporting ARGB visuals out of the box, and
		1542	rxvt-unicode just fudges around.
		1543
		1544	For example, the following selects an almost completely transparent black
		1545	background, and an almost opaque pink foreground:
		1546
		1547	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1548
		1549	When not using a background image, then the interpretation of the
		1550	alpha channel is up to your compositing manager (most interpret it as
		1551	transparency of course).
		1552
		1553	When using a background pixmap or pseudo-transparency, then the background
		1554	colour will always behave as if it were completely transparent (so the
		1555	background image shows instead), regardless of how it was specified, while
		1556	other colours will either be transparent as specified (the background
		1557	image will show through) on servers supporting the RENDER extension, or
		1558	fully opaque on servers not supporting the RENDER EXTENSION.
		1559
		1560	Please note that due to bugs in Xft, specifying alpha values might result
		1561	in garbage being displayed when the X-server does not support the RENDER
		1562	extension.
		1563
		1564	=head1 ENVIRONMENT
		1565
		1566	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1567
1266	=over 4	1568	=over 4
1267		1569
1268	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1269
1270	would yield White on Black, while on I<xterm>(1) it would yield Black
1271	on White.
1272
1273	=back
1274
1275	=head1 ENVIRONMENT
1276
1277	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1278
1279	=over 4
1280
1281	=item B<TERM>	1570	=item B<TERM>
1282		1571
1283	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1572	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1284	resources or on the commandline.	1573	resources or on the command line.
1285		1574
1286	=item B<COLORTERM>	1575	=item B<COLORTERM>
1287		1576
1288	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1577	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1289	compiled with XPM support, and optionally with the added extension	1578	compiled with background image support, and optionally with the added
1290	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1579	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1580	screen.
1291		1581
1292	=item B<COLORFGBG>	1582	=item B<COLORFGBG>
1293		1583
1294	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1584	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1295	the colour code used as default foreground/text colour (or the string	1585	the colour code used as default foreground/text colour (or the string
1296	C<default> to indicate that the default-colour escape sequence is to be	1586	C<default> to indicate that the default-colour escape sequence is to be
1297	used), C<bg> is the colour code used as default background colour (or the	1587	used), C<bg> is the colour code used as default background colour (or the
1298	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1588	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1299	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1589	was compiled with background image support. Libraries like C<ncurses>
1300	(and do) use this information to optimize screen output.	1590	and C<slang> can (and do) use this information to optimize screen output.
1301		1591
1302	=item B<WINDOWID>	1592	=item B<WINDOWID>
1303		1593
1304	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1594	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1305	window, which usually has subwindows for the scrollbar, the terminal	1595	window, which usually has subwindows for the scrollbar, the terminal
…		…
1311	C<--with-terminfo=PATH>.	1601	C<--with-terminfo=PATH>.
1312		1602
1313	=item B<DISPLAY>	1603	=item B<DISPLAY>
1314		1604
1315	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1605	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1316	display in it's child processes.	1606	display in its child processes if C<-display> isn't used to override. It
		1607	defaults to C<:0> if it doesn't exist.
1317		1608
1318	=item B<SHELL>	1609	=item B<SHELL>
1319		1610
1320	The shell to be used for command execution, defaults to C</bin/sh>.	1611	The shell to be used for command execution, defaults to C</bin/sh>.
1321
1322	=item B<RXVTPATH>
1323
1324	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1325	files.
1326
1327	=item B<PATH>
1328
1329	Used in the same way as C<RXVTPATH>.
1330		1612
1331	=item B<RXVT_SOCKET>	1613	=item B<RXVT_SOCKET>
1332		1614
1333	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1615	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1334	@@RXVT_NAME@@d(1).	1616	@@RXVT_NAME@@d(1).
1335		1617
1336	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1618	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1337		1619
1338	=item B<HOME>	1620	=item B<HOME>
1339		1621
1340	Used to locate the default directory for the unix domain socket for	1622	Used to locate the default directory for the unix domain socket for
1341	daemon communications and to locate various resource files (such as	1623	daemon communications and to locate various resource files (such as
1342	C<.Xdefaults>)	1624	C<.Xdefaults>)
1343		1625
1344	=item B<XAPPLRESDIR>	1626	=item B<XAPPLRESDIR>
1345		1627
1346	Directory where various X resource files are being located.	1628	Directory where application-specific X resource files are located.
1347		1629
1348	=item B<XENVIRONMENT>	1630	=item B<XENVIRONMENT>
1349		1631
1350	If set and accessible, gives the name of a X resource file to be loaded by	1632	If set and accessible, gives the name of a X resource file to be loaded by
1351	@@RXVT_NAME@@.	1633	@@RXVT_NAME@@.
…		…
1356		1638
1357	=over 4	1639	=over 4
1358		1640
1359	=item B</usr/lib/X11/rgb.txt>	1641	=item B</usr/lib/X11/rgb.txt>
1360		1642
1361	Color names.	1643	Colour names.
1362		1644
1363	=back	1645	=back
1364		1646
1365	=head1 SEE ALSO	1647	=head1 SEE ALSO
1366		1648
…		…
1372		1654
1373	=item Project Coordinator	1655	=item Project Coordinator
1374		1656
1375	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1657	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1376		1658
1377	L<http://software.schmorp.de/#rxvt-unicode>	1659	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1378		1660
1379	=back	1661	=back
1380		1662
1381	=head1 AUTHORS	1663	=head1 AUTHORS
1382		1664
…		…
1404		1686
1405	Project Coordinator (changes.txt 2.21a to 2.4.5)	1687	Project Coordinator (changes.txt 2.21a to 2.4.5)
1406		1688
1407	=item Geoff Wing L<< <gcw@pobox.com> >>	1689	=item Geoff Wing L<< <gcw@pobox.com> >>
1408		1690
1409	Rewrote screen display and text selection routines. Project Coordinator	1691	Rewrote screen display and text selection routines.
		1692
1410	(changes.txt 2.4.6 - rxvt-unicode)	1693	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1411		1694
1412	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1695	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1413		1696
1414	Forked rxvt-unicode, rewrote most of the display code and internal	1697	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1415	character handling to store text in unicode, improve xterm	1698	extension, random hacks, numerous bugfixes and extensions.
1416	compatibility and apply numerous other bugfixes and extensions.
1417		1699
1418	Project Coordinator (Changes 1.0 -)	1700	Project Coordinator (Changes 1.0 -)
1419		1701
		1702	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1703
		1704	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1705
1420	=back	1706	=back
1421		1707

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.81 by root, Mon Jan 2 21:41:51 2006 UTC vs. Revision 1.199 by sf-exg, Tue Aug 9 21:48:00 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.81 by root, Mon Jan 2 21:41:51 2006 UTC vs.
Revision 1.199 by sf-exg, Tue Aug 9 21:48:00 2011 UTC