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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.82 by root, Tue Jan 3 18:11:34 2006 UTC vs.
Revision 1.207 by sf-exg, Tue Nov 22 13:35:10 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[;oplist]>
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 a list of operations to modify it. 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[;oplist]>
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 a colon separated list of operations to modify it.
620	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	752	Supported operations are:
621	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
623	of 1 displays the image without any scaling. A scale of 2 to 9
624	specifies an integer number of images in that direction. No image will
625	be magnified beyond 10 times its original size. The maximum permitted
626	scale is 1000. [default 0x0+50+50]
627		753
628	=item B<menu:> I<file[;tag]>	754	=over 4
629		755
630	Read in the specified menu file (note the `.menu' extension is	756	=item B<WxH+X+Y>
631	optional) and also optionally specify a starting tag to find. See the	757
632	reference documentation for details on the syntax for the menuBar.	758	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		759	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		760	scale of 0 disables scaling. The maximum permitted scale is 1000.
		761
		762	=item B<op=tile>
		763
		764	enables tiling
		765
		766	=item B<op=pscale>
		767
		768	enables proportional scaling
		769
		770	=item B<op=root>
		771
		772	use the position of the terminal window relative to the root window as
		773	the image offset, simulating a root window background
		774
		775	=back
		776
		777	The default scale and position setting is C<100x100+50+50>.
		778	Alternatively, a predefined set of templates can be used to achieve
		779	the most common setups:
		780
		781	=over 4
		782
		783	=item B<style=tiled>
		784
		785	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		786
		787	=item B<style=aspect-stretched>
		788
		789	the image is scaled to fill the whole window maintaining the aspect
		790	ratio and centered. Equivalent to 100x100+50+50:op=pscale
		791
		792	=item B<style=stretched>
		793
		794	the image is scaled to fill the whole window. Equivalent to 100x100
		795
		796	=item B<style=centered>
		797
		798	the image is centered with no scaling. Equivalent to 0x0+50+50
		799
		800	=item B<style=root-tiled>
		801
		802	the image is tiled with no scaling and using 'root' positioning.
		803	Equivalent to 0x0:op=tile:op=root
		804
		805	=back
		806
		807	If multiple templates are specified the last one wins. Note that a
		808	template overrides all the scale, position and operations settings.
		809
		810	If used in conjunction with B<-tr> option, the specified pixmap will be
		811	blended over the transparent background using alpha-blending. If I<afterimage>
		812	support has been compiled in it is possible to choose other blending
		813	types with B<-blt "type"> option.
633		814
634	=item B<path:> I<path>	815	=item B<path:> I<path>
635		816
636	Specify the colon-delimited search path for finding files (XPM and	817	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		818
640	=item B<font:> I<fontlist>	819	=item B<font:> I<fontlist>
641		820
642	Select the fonts to be used. This is a comma separated list of font	821	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.	822	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	823	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	824	smaller, but not (in general) larger. A (hopefully) reasonable default
646	appended to it; option B<-fn>.	825	font list is always appended to it; option B<-fn>.
647		826
648	Each font can either be a standard X11 core font (XLFD) name, with	827	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:>.	828	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
650		829
651	In addition, each font can be prefixed with additional hints and	830	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	832	hint currently is C<codeset=codeset-name>, and this is only used for Xft
654	fonts.	833	fonts.
655		834
656	For example, this font resource	835	For example, this font resource
657		836
658	URxvt*font: 9x15bold,\	837	URxvt.font: 9x15bold,\
659	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	838	-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, \	839	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
661	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	840	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
662	xft:Code2000:antialias=false	841	xft:Code2000:antialias=false
663		842
…		…
666	it is named first) and thus defines the character cell grid to be 9 pixels	845	it is named first) and thus defines the character cell grid to be 9 pixels
667	wide and 15 pixels high.	846	wide and 15 pixels high.
668		847
669	The second font is just used to add additional unicode characters not in	848	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	849	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	850	the bold version of the font does contain fewer characters, so this is a
672	useful supplement.	851	useful supplement.
673		852
674	The third font is an Xft font with aliasing turned off, and the characters	853	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	854	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.	855	contains other characters, but we are not interested in them.
…		…
700	text font will being used for the given style.	879	text font will being used for the given style.
701		880
702	=item B<intensityStyles:> I<boolean>	881	=item B<intensityStyles:> I<boolean>
703		882
704	When font styles are not enabled, or this option is enabled (B<True>,	883	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	884	option B<-is>, the default), bold/blink font styles imply high
706	intensity foreground/backround colours. Disabling this option (B<False>,	885	intensity foreground/background colours. Disabling this option (B<False>,
707	option B<+is>) disables this behaviour, the high intensity colours are not	886	option B<+is>) disables this behaviour, the high intensity colours are not
708	reachable.	887	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		888
721	=item B<title:> I<string>	889	=item B<title:> I<string>
722		890
723	Set window title string, the default title is the command-line	891	Set window title string, the default title is the command-line
724	specified after the B<-e> option, if any, otherwise the application	892	specified after the B<-e> option, if any, otherwise the application
…		…
733	=item B<mapAlert:> I<boolean>	901	=item B<mapAlert:> I<boolean>
734		902
735	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	903	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].	904	de-iconify (map) on receipt of a bell character [default].
737		905
		906	=item B<urgentOnBell:> I<boolean>
		907
		908	B<True>: set the urgency hint for the wm on receipt of a bell character.
		909	B<False>: do not set the urgency hint [default].
		910
		911	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		912
738	=item B<visualBell:> I<boolean>	913	=item B<visualBell:> I<boolean>
739		914
740	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	915	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
741	B<False>: no visual bell [default]; option B<+vb>.	916	B<False>: no visual bell [default]; option B<+vb>.
742		917
…		…
760		935
761	The string will be interpreted as if typed into the shell as-is.	936	The string will be interpreted as if typed into the shell as-is.
762		937
763	Example:	938	Example:
764		939
765	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	940	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
766		941
767	This creates a new file in your home directory with the screen contents	942	This creates a new file in your home directory with the screen contents
768	everytime you hit C<Print>.	943	every time you hit C<Print>.
		944
		945	=item B<scrollstyle:> I<mode>
		946
		947	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		948	the author's favourite.
		949
		950	=item B<thickness:> I<number>
		951
		952	Set the scrollbar width in pixels.
769		953
770	=item B<scrollBar:> I<boolean>	954	=item B<scrollBar:> I<boolean>
771		955
772	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	956	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
773	disable the scrollbar; option B<+sb>.	957	disable the scrollbar; option B<+sb>.
…		…
793	B<False>: do not scroll to bottom when tty receives output; option	977	B<False>: do not scroll to bottom when tty receives output; option
794	B<+si>.	978	B<+si>.
795		979
796	=item B<scrollWithBuffer:> I<boolean>	980	=item B<scrollWithBuffer:> I<boolean>
797		981
798	B<True>: scroll with scrollback buffer when tty receives new lines (and	982	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	983	try to show the same lines) and B<scrollTtyOutput> is False; option
800	with scrollback buffer when tty recieves new lines; option B<+sw>.	984	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		985	new lines; option B<+sw>.
801		986
802	=item B<scrollTtyKeypress:> I<boolean>	987	=item B<scrollTtyKeypress:> I<boolean>
803		988
804	B<True>: scroll to bottom when a non-special key is pressed. Special keys	989	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	990	are those which are intercepted by rxvt-unicode for special handling and
…		…
824	=item B<borderLess:> I<boolean>	1009	=item B<borderLess:> I<boolean>
825		1010
826	Set MWM hints to request a borderless window, i.e. if honoured by the	1011	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>.	1012	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
828		1013
		1014	=item B<skipBuiltinGlyphs:> I<boolean>
		1015
		1016	Compile I<frills>: Disable the usage of the built-in block graphics/line
		1017	drawing characters and just rely on what the specified fonts provide. Use
		1018	this if you have a good font and want to use its block graphic glyphs;
		1019	option B<-sbg>.
		1020
829	=item B<termName:> I<termname>	1021	=item B<termName:> I<termname>
830		1022
831	Specifies the terminal type name to be set in the B<TERM> environment	1023	Specifies the terminal type name to be set in the B<TERM> environment
832	variable; option B<-tn>.	1024	variable; option B<-tn>.
833		1025
834	=item B<linespace:> I<number>	1026	=item B<lineSpace:> I<number>
835		1027
836	Specifies number of lines (pixel height) to insert between each row of	1028	Specifies number of lines (pixel height) to insert between each row of
837	the display [default 0]; option B<-lsp>.	1029	the display [default 0]; option B<-lsp>.
838		1030
839	=item B<meta8:> I<boolean>	1031	=item B<meta8:> I<boolean>
…		…
853		1045
854	=item B<cursorBlink:> I<boolean>	1046	=item B<cursorBlink:> I<boolean>
855		1047
856	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1048	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
857	option B<-bc>.	1049	option B<-bc>.
		1050
		1051	=item B<cursorUnderline:> I<boolean>
		1052
		1053	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1054	option B<-uc>.
858		1055
859	=item B<pointerBlank:> I<boolean>	1056	=item B<pointerBlank:> I<boolean>
860		1057
861	B<True>: blank the pointer when a key is pressed or after a set number	1058	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	1059	of seconds of inactivity. B<False>: the pointer is always visible
…		…
876	large number (e.g. C<987654321>) to effectively disable the timeout.	1073	large number (e.g. C<987654321>) to effectively disable the timeout.
877		1074
878	=item B<backspacekey:> I<string>	1075	=item B<backspacekey:> I<string>
879		1076
880	The string to send when the backspace key is pressed. If set to B<DEC>	1077	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>	1078	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	1079	(code 8) - which can be reversed with the appropriate DEC private mode
883	escape sequence.	1080	escape sequence.
884		1081
885	=item B<deletekey:> I<string>	1082	=item B<deletekey:> I<string>
886		1083
…		…
888	pressed. If unset it will send the sequence traditionally associated	1085	pressed. If unset it will send the sequence traditionally associated
889	with the B<Execute> key.	1086	with the B<Execute> key.
890		1087
891	=item B<cutchars:> I<string>	1088	=item B<cutchars:> I<string>
892		1089
893	The characters used as delimiters for double-click word selection. The	1090	The characters used as delimiters for double-click word selection
894	built-in default:	1091	(whitespace delimiting is added automatically if resource is given).
895		1092
		1093	When the perl selection extension is in use (the default if compiled
		1094	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1095	characters will be created (if the resource exists, otherwise, no regex
		1096	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1097
		1098	When the selection extension is not used, only ISO-8859-1 characters can
		1099	be used. If not specified, the built-in default is used:
		1100
896	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1101	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
897		1102
898	=item B<preeditType:> I<style>	1103	=item B<preeditType:> I<style>
899		1104
900	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1105	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
901		1106
…		…
935	default. (Note that many other terminals, including xterm, have these	1140	default. (Note that many other terminals, including xterm, have these
936	sequences enabled by default, which doesn't make it safer, though).	1141	sequences enabled by default, which doesn't make it safer, though).
937		1142
938	You can enable them by setting this boolean resource or specifying	1143	You can enable them by setting this boolean resource or specifying
939	B<-insecure> as an option. At the moment, this enables display-answer,	1144	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	1145	locale, findfont, icon label and window title requests.
941	menubar dispatch.
942		1146
943	=item B<modifier:> I<modifier>	1147	=item B<modifier:> I<modifier>
944		1148
945	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1149	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	1150	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
950		1154
951	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1155	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	1156	character is passed through. It may contain escape values as described
953	in the entry on B<keysym> following.	1157	in the entry on B<keysym> following.
954		1158
955	=item B<secondaryScreen:> I<bool>	1159	=item B<secondaryScreen:> I<boolean>
956		1160
957	Turn on/off secondary screen (default enabled).	1161	Turn on/off secondary screen (default enabled).
958		1162
959	=item B<secondaryScroll:> I<bool>	1163	=item B<secondaryScroll:> I<boolean>
960		1164
961	Turn on/off secondary screen scroll (default enabled). If the this	1165	Turn on/off secondary screen scroll (default enabled). If this
962	option is enabled, scrolls on the secondary screen will change the	1166	option is enabled, scrolls on the secondary screen will change the
963	scrollback buffer and switching to/from the secondary screen will	1167	scrollback buffer and, when secondaryScreen is off, switching
964	instead scroll the screen up.	1168	to/from the secondary screen will instead scroll the screen up.
965		1169
966	=item B<hold>: I<bool>	1170	=item B<hold>: I<boolean>
967		1171
968	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1172	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
969	will not immediately destroy its window when the program executed within	1173	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	1174	it exits. Instead, it will wait till it is being killed or closed by the
971	user.	1175	user.
		1176
		1177	=item B<chdir>: I<path>
		1178
		1179	Sets the working directory for the shell (or the command specified via
		1180	B<-e>). The I<path> must be an absolute path and it must exist for
		1181	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1182	directory will be used; option B<-cd>.
972		1183
973	=item B<keysym.>I<sym>: I<string>	1184	=item B<keysym.>I<sym>: I<string>
974		1185
975	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1186	Compile I<frills>: Associate I<string> with keysym I<sym>. The
976	intervening resource name B<keysym.> cannot be omitted.	1187	intervening resource name B<keysym.> cannot be omitted.
…		…
990	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1201	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	1202	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	1203	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.	1204	performed in an exact manner; however, the closest match is assured.
994		1205
995	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1206	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,	1207	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		1208
1006	You can define a range of keysyms in one shot by providing a I<string>	1209	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 `/'	1210	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1008	should be a character not used by the strings.	1211	should be a character not used by the strings.
1009		1212
1010	Its usage can be demonstrated by an example:	1213	Its usage can be demonstrated by an example:
1011		1214
1012	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1215	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1013		1216
1014	The above line is equivalent to the following three lines:	1217	The above line is equivalent to the following three lines:
1015		1218
1016	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1219	URxvt.keysym.Meta-Control-0x61: \033<a>
1017	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1220	URxvt.keysym.Meta-Control-0x62: \033<b>
1018	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1221	URxvt.keysym.Meta-Control-0x63: \033<c>
1019		1222
1020	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1223	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	1224	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>	1225	example the following means "change the current locale to C<zh_CN.GBK>
1023	when Control-Meta-c is being pressed":	1226	when Control-Meta-c is being pressed":
1024		1227
1025	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1228	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1026		1229
1027	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1230	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)	1231	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	1232	manpage. For example, the F<selection> extension (activated via
1030	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1233	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1031		1234
1032	URxvt.keysym.M-C-c: perl:selection:rot13	1235	URxvt.keysym.M-C-c: perl:selection:rot13
1033		1236
1034	Due the the large number of modifier combinations, a defined key mapping	1237	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	1238	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	1239	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	1240	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	1241	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1039	mappings themselves.	1242	mappings themselves.
1040		1243
…		…
1061	info):	1264	info):
1062		1265
1063	URxvt.keysym.M-C-3: command:\033[8;25;80t	1266	URxvt.keysym.M-C-3: command:\033[8;25;80t
1064	URxvt.keysym.M-C-4: command:\033[8;48;110t	1267	URxvt.keysym.M-C-4: command:\033[8;48;110t
1065		1268
		1269	=item B<perl-ext-common>: I<string>
		1270
1066	=item B<perl-ext>: I<string>	1271	=item B<perl-ext>: I<string>
1067		1272
1068	Colon-separated list of perl extension scripts to use in this terminal	1273	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1274	use in this terminal instance; option B<-pe>.
		1275
		1276	Extension names can be prefixed with a C<-> sign to prohibit using
		1277	them. This can be useful to selectively disable some extensions loaded
		1278	by default, or specified via the C<perl-ext-common> resource. For
		1279	example, C<default,-selection> will use all the default extension except
		1280	C<selection>.
		1281
		1282	Extension names can also be followed by an argument in angle brackets
		1283	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1284	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1285	multiple times with different arguments will pass multiple arguments to
		1286	the extension.
		1287
1069	instance. Each extension is looked up in the library directories, loaded	1288	Each extension is looked up in the library directories, loaded if
1070	if necessary, and bound to the current terminal instance. If this resource	1289	necessary, and bound to the current terminal instance.
1071	is empty or missing, then the perl interpreter will not be initialized;	1290
1072	option B<-pe>.	1291	If both of these resources are the empty string, then the perl
		1292	interpreter will not be initialized. The idea behind two options is that
		1293	B<perl-ext-common> will be used for extensions that should be available to
		1294	all instances, while B<perl-ext> is used for specific instances.
1073		1295
1074	=item B<perl-eval>: I<string>	1296	=item B<perl-eval>: I<string>
1075		1297
1076	Perl code to be evaluated when all extensions have been registered. See the	1298	Perl code to be evaluated when all extensions have been registered. See
1077	@@RXVT_NAME@@perl(3) manpage.	1299	the @@RXVT_NAME@@perl(3) manpage.
1078		1300
1079	=item B<perl-lib>: I<path>	1301	=item B<perl-lib>: I<path>
1080		1302
1081	Colon-separated list of additional directories that hold extension	1303	Colon-separated list of additional directories that hold extension
1082	scripts. When looking for extensions specified by the C<perl> resource,	1304	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1083	@@RXVT_NAME@@ will first look in these directories and then in	1305	look in these directories, then in $HOME/.urxvt/ext and lastly in
1084	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1306	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1085		1307
1086	See the @@RXVT_NAME@@perl(3) manpage.	1308	See the @@RXVT_NAME@@perl(3) manpage.
		1309
		1310	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1311
		1312	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1313	details.
		1314
		1315	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1316
		1317	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1318	for details.
		1319
		1320	=item B<searchable-scrollback:> I<keysym>
		1321
		1322	Sets the hotkey that starts the incremental scrollback buffer search
		1323	(default: C<M-s>).
		1324
		1325	=item B<urlLauncher>: I<string>
		1326
		1327	Specifies the program to be started with a URL argument. Used by the
		1328	C<selection-popup> and C<matcher> perl extensions.
		1329
		1330	=item B<transient-for>: I<windowid>
		1331
		1332	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1333
		1334	=item B<override-redirect>: I<boolean>
		1335
		1336	Compile I<frills>: Sets override-redirect for the terminal window, making
		1337	it almost invisible to window managers; option B<-override-redirect>.
		1338
		1339	=item B<iso14755:> I<boolean>
		1340
		1341	Turn on/off ISO 14755 (default enabled).
		1342
		1343	=item B<iso14755_52:> I<boolean>
		1344
		1345	Turn on/off ISO 14755 5.2 mode (default enabled).
1087		1346
1088	=back	1347	=back
1089		1348
1090	=head1 THE SCROLLBAR	1349	=head1 THE SCROLLBAR
1091		1350
…		…
1110	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1369	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1111	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1370	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1112	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1371	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1113	respectively.	1372	respectively.
1114		1373
1115	=head1 TEXT SELECTION AND INSERTION	1374	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1116		1375
1117	The behaviour of text selection and insertion mechanism is similar to	1376	The behaviour of text selection and insertion/pasting mechanism is similar
1118	I<xterm>(1).	1377	to I<xterm>(1).
1119		1378
1120	=over 4	1379	=over 4
1121		1380
1122	=item B<Selection>:	1381	=item B<Selecting>:
1123		1382
1124	Left click at the beginning of the region, drag to the end of the region	1383	Left click at the beginning of the region, drag to the end of the region
1125	and release; Right click to extend the marked region; Left double-click	1384	and release; Right click to extend the marked region; Left double-click
1126	to select a word; Left triple-click to select the entire logical line	1385	to select a word; Left triple-click to select the entire logical line
1127	(which can span multiple screen lines), unless modified by resource	1386	(which can span multiple screen lines), unless modified by resource
…		…
1131	(Compile: I<frills>) will create a rectangular selection instead of a	1390	(Compile: I<frills>) will create a rectangular selection instead of a
1132	normal one. In this mode, every selected row becomes its own line in the	1391	normal one. In this mode, every selected row becomes its own line in the
1133	selection, and trailing whitespace is visually underlined and removed from	1392	selection, and trailing whitespace is visually underlined and removed from
1134	the selection.	1393	the selection.
1135		1394
1136	=item B<Insertion>:	1395	=item B<Pasting>:
1137		1396
1138	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1397	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1139	an B<@@RXVT_NAME@@> window causes the current text selection to be	1398	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1140	inserted as if it had been typed on the keyboard.	1399	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1400
		1401	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1402	inserted too.
1141		1403
1142	=back	1404	=back
1143		1405
1144	=head1 CHANGING FONTS	1406	=head1 CHANGING FONTS
1145		1407
1146	Changing fonts (or font sizes, respectively) via the keypad is not yet	1408	Changing fonts (or font sizes, respectively) via the keypad is not yet
1147	supported in rxvt-unicode. Bug me if you need this.	1409	supported in rxvt-unicode. Bug me if you need this.
1148		1410
1149	You can, however, switch fonts at runtime using escape sequences (and	1411	You can, however, switch fonts at runtime using escape sequences, e.g.:
1150	therefore using the menubar), e.g.:
1151		1412
1152	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1413	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1414
		1415	You can use keyboard shortcuts, too:
		1416
		1417	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1418	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1153		1419
1154	rxvt-unicode will automatically re-apply these fonts to the output so far.	1420	rxvt-unicode will automatically re-apply these fonts to the output so far.
1155		1421
1156	=head1 ISO 14755 SUPPORT	1422	=head1 ISO 14755 SUPPORT
1157		1423
1158	ISO 14755 is a standard for entering and viewing unicode characters	1424	ISO 14755 is a standard for entering and viewing unicode characters
1159	and character codes using the keyboard. It consists of 4 parts. The	1425	and character codes using the keyboard. It consists of 4 parts. The
1160	first part is available rxvt-unicode has been compiled with	1426	first part is available if rxvt-unicode has been compiled with
1161	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1427	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1162	with C<--enable-iso14755>.	1428	with C<--enable-iso14755>.
1163		1429
1164	=over 4	1430	=over 4
1165		1431
…		…
1185	This mode lets you input characters representing the keycap symbols of	1451	This mode lets you input characters representing the keycap symbols of
1186	your keyboard, if representable in the current locale encoding.	1452	your keyboard, if representable in the current locale encoding.
1187		1453
1188	Start by pressing C<Control> and C<Shift> together, then releasing	1454	Start by pressing C<Control> and C<Shift> together, then releasing
1189	them. The next special key (cursor keys, home etc.) you enter will not	1455	them. The next special key (cursor keys, home etc.) you enter will not
1190	invoke it's usual function but instead will insert the corresponding	1456	invoke its usual function but instead will insert the corresponding
1191	keycap symbol. The symbol will only be entered when the key has been	1457	keycap symbol. The symbol will only be entered when the key has been
1192	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1458	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1193	C<ISO Level 2 Switch>, although your intention might have been to enter a	1459	C<ISO Level 2 Switch>, although your intention might have been to enter a
1194	reverse tab (Shift-Tab).	1460	reverse tab (Shift-Tab).
1195		1461
…		…
1223	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1489	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1224	it can be seen via the I<who(1)> command, and can accept messages. To	1490	it can be seen via the I<who(1)> command, and can accept messages. To
1225	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1491	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1226	on some systems or setgid to root or to some other group on others.	1492	on some systems or setgid to root or to some other group on others.
1227		1493
1228	=head1 COLORS AND GRAPHICS	1494	=head1 COLOURS AND GRAPHICS
1229		1495
1230	In addition to the default foreground and background colours,	1496	In addition to the default foreground and background colours,
1231	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1497	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1232	high-intensity bold/blink versions of the same). Here is a list of the	1498	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1233	colours with their B<rgb.txt> names.	1499	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1500	cube plus a 8 (24) colour greyscale ramp.
		1501
		1502	Here is a list of the ANSI colours with their names.
1234		1503
1235	=begin table	1504	=begin table
1236		1505
1237	B<color0> (black) = Black	1506	B<color0> (black) = Black
1238	B<color1> (red) = Red3	1507	B<color1> (red) = Red3
…		…
1258	It is also possible to specify the colour values of B<foreground>,	1527	It is also possible to specify the colour values of B<foreground>,
1259	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1528	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1260	a number 0-15, as a convenient shorthand to reference the colour name of	1529	a number 0-15, as a convenient shorthand to reference the colour name of
1261	color0-color15.	1530	color0-color15.
1262		1531
		1532	The following text gives values for the standard 88 colour mode (and
		1533	values for the 256 colour mode in parentheses).
		1534
		1535	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1536
		1537	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1538	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1539
		1540	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1541	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1542	the RGB cube.
		1543
		1544	Together, all those colours implement the 88 (256) colour xterm
		1545	colours. Only the first 16 can be changed using resources currently, the
		1546	rest can only be changed via command sequences ("escape codes").
		1547
		1548	Applications are advised to use terminfo or command sequences to discover
		1549	number and RGB values of all colours (yes, you can query this...).
		1550
1263	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1551	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1264	always swapping the foreground/background colours. This is in contrast to	1552	always swapping the foreground/background colours. This is in contrast to
1265	I<xterm>(1) where the colours are only swapped if they have not otherwise	1553	I<xterm>(1) where the colours are only swapped if they have not otherwise
1266	been specified. For example,	1554	been specified. For example,
1267		1555
		1556	@@RXVT_NAME@@ -fg Black -bg White -rv
		1557
		1558	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1559	White.
		1560
		1561	=head2 ALPHA CHANNEL SUPPORT
		1562
		1563	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1564	their act together, rxvt-unicode will do it's own alpha channel management:
		1565
		1566	You can prefix any colour with an opaqueness percentage enclosed in
		1567	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1568	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1569	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1570	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1571	is the recommended format to specify transparency values, and works with
		1572	all ways to specify a colour.
		1573
		1574	For complete control, rxvt-unicode also supports
		1575	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1576	specifications, where the additional C<aaaa> component specifies opacity
		1577	(alpha) values. The minimum value of C<0000> is completely transparent,
		1578	while C<ffff> is completely opaque). The two example colours from
		1579	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1580	C<rgba:0000/ff00/0000/f332>.
		1581
		1582	You probably need to specify B<"-depth 32">, too, to force a visual with
		1583	alpha channels, and have the luck that your X-server uses ARGB pixel
		1584	layout, as X is far from just supporting ARGB visuals out of the box, and
		1585	rxvt-unicode just fudges around.
		1586
		1587	For example, the following selects an almost completely transparent black
		1588	background, and an almost opaque pink foreground:
		1589
		1590	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1591
		1592	When not using a background image, then the interpretation of the
		1593	alpha channel is up to your compositing manager (most interpret it as
		1594	transparency of course).
		1595
		1596	When using a background pixmap or pseudo-transparency, then the background
		1597	colour will always behave as if it were completely transparent (so the
		1598	background image shows instead), regardless of how it was specified, while
		1599	other colours will either be transparent as specified (the background
		1600	image will show through) on servers supporting the RENDER extension, or
		1601	fully opaque on servers not supporting the RENDER EXTENSION.
		1602
		1603	Please note that due to bugs in Xft, specifying alpha values might result
		1604	in garbage being displayed when the X-server does not support the RENDER
		1605	extension.
		1606
		1607	=head1 ENVIRONMENT
		1608
		1609	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1610
1268	=over 4	1611	=over 4
1269		1612
1270	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1271
1272	would yield White on Black, while on I<xterm>(1) it would yield Black
1273	on White.
1274
1275	=back
1276
1277	=head1 ENVIRONMENT
1278
1279	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1280
1281	=over 4
1282
1283	=item B<TERM>	1613	=item B<TERM>
1284		1614
1285	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1615	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1286	resources or on the commandline.	1616	resources or on the command line.
1287		1617
1288	=item B<COLORTERM>	1618	=item B<COLORTERM>
1289		1619
1290	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1620	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1291	compiled with XPM support, and optionally with the added extension	1621	compiled with background image support, and optionally with the added
1292	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1622	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1623	screen.
1293		1624
1294	=item B<COLORFGBG>	1625	=item B<COLORFGBG>
1295		1626
1296	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1627	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1297	the colour code used as default foreground/text colour (or the string	1628	the colour code used as default foreground/text colour (or the string
1298	C<default> to indicate that the default-colour escape sequence is to be	1629	C<default> to indicate that the default-colour escape sequence is to be
1299	used), C<bg> is the colour code used as default background colour (or the	1630	used), C<bg> is the colour code used as default background colour (or the
1300	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1631	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1301	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1632	was compiled with background image support. Libraries like C<ncurses>
1302	(and do) use this information to optimize screen output.	1633	and C<slang> can (and do) use this information to optimize screen output.
1303		1634
1304	=item B<WINDOWID>	1635	=item B<WINDOWID>
1305		1636
1306	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1637	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1307	window, which usually has subwindows for the scrollbar, the terminal	1638	window, which usually has subwindows for the scrollbar, the terminal
…		…
1313	C<--with-terminfo=PATH>.	1644	C<--with-terminfo=PATH>.
1314		1645
1315	=item B<DISPLAY>	1646	=item B<DISPLAY>
1316		1647
1317	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1648	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1318	display in it's child processes.	1649	display in its child processes if C<-display> isn't used to override. It
		1650	defaults to C<:0> if it doesn't exist.
1319		1651
1320	=item B<SHELL>	1652	=item B<SHELL>
1321		1653
1322	The shell to be used for command execution, defaults to C</bin/sh>.	1654	The shell to be used for command execution, defaults to C</bin/sh>.
1323
1324	=item B<RXVTPATH>
1325
1326	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1327	files.
1328
1329	=item B<PATH>
1330
1331	Used in the same way as C<RXVTPATH>.
1332		1655
1333	=item B<RXVT_SOCKET>	1656	=item B<RXVT_SOCKET>
1334		1657
1335	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1658	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1336	@@RXVT_NAME@@d(1).	1659	@@RXVT_NAME@@d(1).
1337		1660
1338	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1661	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1339		1662
1340	=item B<HOME>	1663	=item B<HOME>
1341		1664
1342	Used to locate the default directory for the unix domain socket for	1665	Used to locate the default directory for the unix domain socket for
1343	daemon communications and to locate various resource files (such as	1666	daemon communications and to locate various resource files (such as
1344	C<.Xdefaults>)	1667	C<.Xdefaults>)
1345		1668
1346	=item B<XAPPLRESDIR>	1669	=item B<XAPPLRESDIR>
1347		1670
1348	Directory where various X resource files are being located.	1671	Directory where application-specific X resource files are located.
1349		1672
1350	=item B<XENVIRONMENT>	1673	=item B<XENVIRONMENT>
1351		1674
1352	If set and accessible, gives the name of a X resource file to be loaded by	1675	If set and accessible, gives the name of a X resource file to be loaded by
1353	@@RXVT_NAME@@.	1676	@@RXVT_NAME@@.
…		…
1358		1681
1359	=over 4	1682	=over 4
1360		1683
1361	=item B</usr/lib/X11/rgb.txt>	1684	=item B</usr/lib/X11/rgb.txt>
1362		1685
1363	Color names.	1686	Colour names.
1364		1687
1365	=back	1688	=back
1366		1689
1367	=head1 SEE ALSO	1690	=head1 SEE ALSO
1368		1691
…		…
1374		1697
1375	=item Project Coordinator	1698	=item Project Coordinator
1376		1699
1377	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1700	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1378		1701
1379	L<http://software.schmorp.de/#rxvt-unicode>	1702	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1380		1703
1381	=back	1704	=back
1382		1705
1383	=head1 AUTHORS	1706	=head1 AUTHORS
1384		1707
…		…
1406		1729
1407	Project Coordinator (changes.txt 2.21a to 2.4.5)	1730	Project Coordinator (changes.txt 2.21a to 2.4.5)
1408		1731
1409	=item Geoff Wing L<< <gcw@pobox.com> >>	1732	=item Geoff Wing L<< <gcw@pobox.com> >>
1410		1733
1411	Rewrote screen display and text selection routines. Project Coordinator	1734	Rewrote screen display and text selection routines.
		1735
1412	(changes.txt 2.4.6 - rxvt-unicode)	1736	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1413		1737
1414	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1738	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1415		1739
1416	Forked rxvt-unicode, rewrote most of the display code and internal	1740	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1417	character handling to store text in unicode, improve xterm	1741	extension, random hacks, numerous bugfixes and extensions.
1418	compatibility and apply numerous other bugfixes and extensions.
1419		1742
1420	Project Coordinator (Changes 1.0 -)	1743	Project Coordinator (Changes 1.0 -)
1421		1744
		1745	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1746
		1747	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1748
1422	=back	1749	=back
1423		1750

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.82 by root, Tue Jan 3 18:11:34 2006 UTC vs. Revision 1.207 by sf-exg, Tue Nov 22 13:35:10 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.82 by root, Tue Jan 3 18:11:34 2006 UTC vs.
Revision 1.207 by sf-exg, Tue Nov 22 13:35:10 2011 UTC