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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.76 by root, Sat Dec 31 16:06:48 2005 UTC vs.
Revision 1.201 by sf-exg, Wed Aug 10 07:34:35 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;
…		…
453		540
454	# now communicate with rxvt	541	# now communicate with rxvt
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
		545	=item B<-pe> I<string>
		546
		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.
		549
458	=back	550	=back
459		551
460	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
461		553
462	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
463	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
464		557
465	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
466	Xresource data: using the X libraries (Xrm*-functions) or internal	559	distribution do also load settings from the B<~/.Xresources> file when X
467	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
468	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	561	with later settings overwriting earlier ones:
469	resources using X11 tools like B<xrdb>. Many distribution do also load
470	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
471	will consult the following files/resources in order, with later settings
472	overwriting earlier ones:
473		562
474	1. system-wide app-defaults file, either locale-dependent OR global
475	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
476	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
477	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
478	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
479		569
480	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
481	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
482	set in XAPPLOADDIR/URxvt (compile-time defined: usually
483	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
484	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
485	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
486	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
487	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
488	easily configured, while the class name B<URxvt> allows resources	573	configured, while the class name B<URxvt> allows resources unique to
489	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	574	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
490	shared between different B<@@RXVT_NAME@@> configurations. If no	575	configurations. If no resources are specified, suitable defaults will
491	resources are specified, suitable defaults will be used. Command-line	576	be used. Command-line arguments can be used to override resource
492	arguments can be used to override resource settings. The following	577	settings. The following resources are supported (you might want to
493	resources are allowed:	578	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		579	extensions not documented here):
494		580
495	=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.
496		594
497	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
498		596
499	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
500	option B<-geometry>.	598	option B<-geometry>.
…		…
514	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
515	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
516	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
517	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,
518	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
519	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
520		618
521	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
522	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
523		621
524	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
…		…
535	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
536		634
537	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
538	foreground colour is the default.	636	foreground colour is the default.
539		637
540	=item B<colorRV:> I<colour>
541
542	Use the specified colour as the background for reverse video
543	characters.
544
545	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
546		639
547	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
548	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.
549		652
550	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
551		654
552	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
553	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
560		663
561	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
562		665
563	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
564	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
565	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
566		669
567	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
568		671
569	B<True>: specify that jump scrolling should be used. When scrolling	672	B<True>: specify that jump scrolling should be used. When receiving lots
570	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
571	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>.
572		679
573	=item B<inheritPixmap:> I<boolean>	680	=item B<skipScroll:> I<boolean>
574		681
575	B<True>: make the background inherit the parent windows' pixmap, giving	682	B<True>: (the default) specify that skip scrolling should be used. When
576	artificial transparency. B<False>: do not inherit the parent windows'	683	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
577	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.
578		698
579	=item B<fading:> I<number>	699	=item B<fading:> I<number>
580		700
581	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>.
582		702
…		…
585	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
586	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
587		707
588	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
589		709
590	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
591	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>.
592		715
593	=item B<shading:> I<number>	716	=item B<shading:> I<number>
594		717
595	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
596	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>.
597		733
598	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
599		735
600	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
601		737
…		…
607	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
608		744
609	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
610	and the text.	746	and the text.
611		747
612	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
613		749
614	Use the specified XPM file (note the `.xpm' extension is optional) for	750	Use the specified image file for the background and also
615	the background and also optionally specify its scaling with a geometry	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
616	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
617	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
618	centre (percent). A scale of 0 displays the image with tiling. A scale	754	centre (percent). A scale of 0 disables scaling.
619	of 1 displays the image without any scaling. A scale of 2 to 9	755	The maximum permitted scale is 1000.
620	specifies an integer number of images in that direction. No image will	756	Additional operations can be specified after colon B<:op1:op2...>.
621	be magnified beyond 10 times its original size. The maximum permitted	757	Supported operations are:
622	scale is 1000. [default 0x0+50+50]
623		758
624	=item B<menu:> I<file[;tag]>	759	tile will tile image
		760	propscale will scale image keeping proportions
		761	scale will scale image to match window size
		762	center will center image with no scaling
		763	root will tile image as if it was a root window background, auto-adjusting
		764	whenever terminal window moves
625		765
626	Read in the specified menu file (note the `.menu' extension is	766	If used in conjunction with B<-tr> option, the specified pixmap will be
627	optional) and also optionally specify a starting tag to find. See the	767	blended over the transparent background using alpha-blending. If I<afterimage>
628	reference documentation for details on the syntax for the menuBar.	768	support has been compiled in it is possible to choose other blending
		769	types with B<-blt "type"> option.
629		770
630	=item B<path:> I<path>	771	=item B<path:> I<path>
631		772
632	Specify the colon-delimited search path for finding files (XPM and	773	Specify the colon-delimited search path for finding background image files.
633	menus), in addition to the paths specified by the B<RXVTPATH> and
634	B<PATH> environment variables.
635		774
636	=item B<font:> I<fontlist>	775	=item B<font:> I<fontlist>
637		776
638	Select the fonts to be used. This is a comma separated list of font	777	Select the fonts to be used. This is a comma separated list of font names
639	names that are used in turn when trying to display Unicode characters.	778	that are checked in order when trying to find glyphs for characters. The
640	The first font defines the cell size for characters; other fonts might	779	first font defines the cell size for characters; other fonts might be
641	be smaller, but not larger. A reasonable default font list is always	780	smaller, but not (in general) larger. A (hopefully) reasonable default
642	appended to it. option B<-fn>.	781	font list is always appended to it; option B<-fn>.
643		782
644	Each font can either be a standard X11 core font (XLFD) name, with	783	Each font can either be a standard X11 core font (XLFD) name, with
645	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	784	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
646		785
647	In addition, each font can be prefixed with additional hints and	786	In addition, each font can be prefixed with additional hints and
…		…
649	hint currently is C<codeset=codeset-name>, and this is only used for Xft	788	hint currently is C<codeset=codeset-name>, and this is only used for Xft
650	fonts.	789	fonts.
651		790
652	For example, this font resource	791	For example, this font resource
653		792
654	URxvt*font: 9x15bold,\	793	URxvt.font: 9x15bold,\
655	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	794	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
656	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	795	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
657	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	796	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
658	xft:Code2000:antialias=false	797	xft:Code2000:antialias=false
659		798
…		…
662	it is named first) and thus defines the character cell grid to be 9 pixels	801	it is named first) and thus defines the character cell grid to be 9 pixels
663	wide and 15 pixels high.	802	wide and 15 pixels high.
664		803
665	The second font is just used to add additional unicode characters not in	804	The second font is just used to add additional unicode characters not in
666	the base font, likewise the third, which is unfortunately non-bold, but	805	the base font, likewise the third, which is unfortunately non-bold, but
667	the bold version of the font does contain less characters, so this is a	806	the bold version of the font does contain fewer characters, so this is a
668	useful supplement.	807	useful supplement.
669		808
670	The third font is an Xft font with aliasing turned off, and the characters	809	The third font is an Xft font with aliasing turned off, and the characters
671	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	810	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
672	contains other characters, but we are not interested in them.	811	contains other characters, but we are not interested in them.
…		…
696	text font will being used for the given style.	835	text font will being used for the given style.
697		836
698	=item B<intensityStyles:> I<boolean>	837	=item B<intensityStyles:> I<boolean>
699		838
700	When font styles are not enabled, or this option is enabled (B<True>,	839	When font styles are not enabled, or this option is enabled (B<True>,
701	option B<-is>, the default), bold and italic font styles imply high	840	option B<-is>, the default), bold/blink font styles imply high
702	intensity foreground/backround colours. Disabling this option (B<False>,	841	intensity foreground/background colours. Disabling this option (B<False>,
703	option B<+is>) disables this behaviour, the high intensity colours are not	842	option B<+is>) disables this behaviour, the high intensity colours are not
704	reachable.	843	reachable.
705
706	=item B<selectstyle:> I<mode>
707
708	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
709	xterm style with 2.20 old word selection, or anything else which gives
710	xterm style selection.
711
712	=item B<scrollstyle:> I<mode>
713
714	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
715	the author's favourite.
716		844
717	=item B<title:> I<string>	845	=item B<title:> I<string>
718		846
719	Set window title string, the default title is the command-line	847	Set window title string, the default title is the command-line
720	specified after the B<-e> option, if any, otherwise the application	848	specified after the B<-e> option, if any, otherwise the application
…		…
729	=item B<mapAlert:> I<boolean>	857	=item B<mapAlert:> I<boolean>
730		858
731	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	859	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
732	de-iconify (map) on receipt of a bell character [default].	860	de-iconify (map) on receipt of a bell character [default].
733		861
		862	=item B<urgentOnBell:> I<boolean>
		863
		864	B<True>: set the urgency hint for the wm on receipt of a bell character.
		865	B<False>: do not set the urgency hint [default].
		866
		867	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		868
734	=item B<visualBell:> I<boolean>	869	=item B<visualBell:> I<boolean>
735		870
736	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	871	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
737	B<False>: no visual bell [default]; option B<+vb>.	872	B<False>: no visual bell [default]; option B<+vb>.
738		873
…		…
756		891
757	The string will be interpreted as if typed into the shell as-is.	892	The string will be interpreted as if typed into the shell as-is.
758		893
759	Example:	894	Example:
760		895
761	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	896	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762		897
763	This creates a new file in your home directory with the screen contents	898	This creates a new file in your home directory with the screen contents
764	everytime you hit C<Print>.	899	every time you hit C<Print>.
		900
		901	=item B<scrollstyle:> I<mode>
		902
		903	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		904	the author's favourite.
		905
		906	=item B<thickness:> I<number>
		907
		908	Set the scrollbar width in pixels.
765		909
766	=item B<scrollBar:> I<boolean>	910	=item B<scrollBar:> I<boolean>
767		911
768	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	912	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
769	disable the scrollbar; option B<+sb>.	913	disable the scrollbar; option B<+sb>.
…		…
789	B<False>: do not scroll to bottom when tty receives output; option	933	B<False>: do not scroll to bottom when tty receives output; option
790	B<+si>.	934	B<+si>.
791		935
792	=item B<scrollWithBuffer:> I<boolean>	936	=item B<scrollWithBuffer:> I<boolean>
793		937
794	B<True>: scroll with scrollback buffer when tty receives new lines (and	938	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
795	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	939	try to show the same lines) and B<scrollTtyOutput> is False; option
796	with scrollback buffer when tty recieves new lines; option B<+sw>.	940	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		941	new lines; option B<+sw>.
797		942
798	=item B<scrollTtyKeypress:> I<boolean>	943	=item B<scrollTtyKeypress:> I<boolean>
799		944
800	B<True>: scroll to bottom when a non-special key is pressed. Special keys	945	B<True>: scroll to bottom when a non-special key is pressed. Special keys
801	are those which are intercepted by rxvt-unicode for special handling and	946	are those which are intercepted by rxvt-unicode for special handling and
…		…
820	=item B<borderLess:> I<boolean>	965	=item B<borderLess:> I<boolean>
821		966
822	Set MWM hints to request a borderless window, i.e. if honoured by the	967	Set MWM hints to request a borderless window, i.e. if honoured by the
823	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	968	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
824		969
		970	=item B<skipBuiltinGlyphs:> I<boolean>
		971
		972	Compile I<frills>: Disable the usage of the built-in block graphics/line
		973	drawing characters and just rely on what the specified fonts provide. Use
		974	this if you have a good font and want to use its block graphic glyphs;
		975	option B<-sbg>.
		976
825	=item B<termName:> I<termname>	977	=item B<termName:> I<termname>
826		978
827	Specifies the terminal type name to be set in the B<TERM> environment	979	Specifies the terminal type name to be set in the B<TERM> environment
828	variable; option B<-tn>.	980	variable; option B<-tn>.
829		981
830	=item B<linespace:> I<number>	982	=item B<lineSpace:> I<number>
831		983
832	Specifies number of lines (pixel height) to insert between each row of	984	Specifies number of lines (pixel height) to insert between each row of
833	the display [default 0]; option B<-lsp>.	985	the display [default 0]; option B<-lsp>.
834		986
835	=item B<meta8:> I<boolean>	987	=item B<meta8:> I<boolean>
…		…
849		1001
850	=item B<cursorBlink:> I<boolean>	1002	=item B<cursorBlink:> I<boolean>
851		1003
852	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1004	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
853	option B<-bc>.	1005	option B<-bc>.
		1006
		1007	=item B<cursorUnderline:> I<boolean>
		1008
		1009	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1010	option B<-uc>.
854		1011
855	=item B<pointerBlank:> I<boolean>	1012	=item B<pointerBlank:> I<boolean>
856		1013
857	B<True>: blank the pointer when a key is pressed or after a set number	1014	B<True>: blank the pointer when a key is pressed or after a set number
858	of seconds of inactivity. B<False>: the pointer is always visible	1015	of seconds of inactivity. B<False>: the pointer is always visible
…		…
872	large number (e.g. C<987654321>) to effectively disable the timeout.	1029	large number (e.g. C<987654321>) to effectively disable the timeout.
873		1030
874	=item B<backspacekey:> I<string>	1031	=item B<backspacekey:> I<string>
875		1032
876	The string to send when the backspace key is pressed. If set to B<DEC>	1033	The string to send when the backspace key is pressed. If set to B<DEC>
877	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1034	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
878	(code 8) - which can be reversed with the appropriate DEC private mode	1035	(code 8) - which can be reversed with the appropriate DEC private mode
879	escape sequence.	1036	escape sequence.
880		1037
881	=item B<deletekey:> I<string>	1038	=item B<deletekey:> I<string>
882		1039
…		…
884	pressed. If unset it will send the sequence traditionally associated	1041	pressed. If unset it will send the sequence traditionally associated
885	with the B<Execute> key.	1042	with the B<Execute> key.
886		1043
887	=item B<cutchars:> I<string>	1044	=item B<cutchars:> I<string>
888		1045
889	The characters used as delimiters for double-click word selection. The	1046	The characters used as delimiters for double-click word selection
890	built-in default:	1047	(whitespace delimiting is added automatically if resource is given).
891		1048
		1049	When the perl selection extension is in use (the default if compiled
		1050	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1051	characters will be created (if the resource exists, otherwise, no regex
		1052	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1053
		1054	When the selection extension is not used, only ISO-8859-1 characters can
		1055	be used. If not specified, the built-in default is used:
		1056
892	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1057	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
893		1058
894	=item B<preeditType:> I<style>	1059	=item B<preeditType:> I<style>
895		1060
896	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1061	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
897		1062
…		…
902	=item B<imLocale:> I<name>	1067	=item B<imLocale:> I<name>
903		1068
904	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	1069	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
905	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	1070	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
906	input extension to be able to input japanese characters while staying in	1071	input extension to be able to input japanese characters while staying in
907	another locale. option B<-imlocale>.	1072	another locale; option B<-imlocale>.
908		1073
909	=item B<imFont:> I<fontset>	1074	=item B<imFont:> I<fontset>
910		1075
911	Specify the font-set used for XIM styles C<OverTheSpot> or	1076	Specify the font-set used for XIM styles C<OverTheSpot> or
912	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	1077	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
917		1082
918	=item B<tripleclickwords:> I<boolean>	1083	=item B<tripleclickwords:> I<boolean>
919		1084
920	Change the meaning of triple-click selection with the left mouse	1085	Change the meaning of triple-click selection with the left mouse
921	button. Instead of selecting a full line it will extend the selection to	1086	button. Instead of selecting a full line it will extend the selection to
922	the end of the logical line only. option B<-tcw>.	1087	the end of the logical line only; option B<-tcw>.
923		1088
924	=item B<insecure:> I<boolean>	1089	=item B<insecure:> I<boolean>
925		1090
926	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1091	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
927	echo arbitrary strings like the icon name or the locale. This could be	1092	echo arbitrary strings like the icon name or the locale. This could be
…		…
931	default. (Note that many other terminals, including xterm, have these	1096	default. (Note that many other terminals, including xterm, have these
932	sequences enabled by default, which doesn't make it safer, though).	1097	sequences enabled by default, which doesn't make it safer, though).
933		1098
934	You can enable them by setting this boolean resource or specifying	1099	You can enable them by setting this boolean resource or specifying
935	B<-insecure> as an option. At the moment, this enables display-answer,	1100	B<-insecure> as an option. At the moment, this enables display-answer,
936	locale, findfont, icon label and window title requests as well as dynamic	1101	locale, findfont, icon label and window title requests.
937	menubar dispatch.
938		1102
939	=item B<modifier:> I<modifier>	1103	=item B<modifier:> I<modifier>
940		1104
941	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1105	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
942	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1106	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
946		1110
947	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1111	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
948	character is passed through. It may contain escape values as described	1112	character is passed through. It may contain escape values as described
949	in the entry on B<keysym> following.	1113	in the entry on B<keysym> following.
950		1114
951	=item B<secondaryScreen:> I<bool>	1115	=item B<secondaryScreen:> I<boolean>
952		1116
953	Turn on/off secondary screen (default enabled).	1117	Turn on/off secondary screen (default enabled).
954		1118
955	=item B<secondaryScroll:> I<bool>	1119	=item B<secondaryScroll:> I<boolean>
956		1120
957	Turn on/off secondary screen scroll (default enabled). If the this	1121	Turn on/off secondary screen scroll (default enabled). If this
958	option is enabled, scrolls on the secondary screen will change the	1122	option is enabled, scrolls on the secondary screen will change the
959	scrollback buffer and switching to/from the secondary screen will	1123	scrollback buffer and, when secondaryScreen is off, switching
960	instead scroll the screen up.	1124	to/from the secondary screen will instead scroll the screen up.
961		1125
962	=item B<hold>: I<bool>	1126	=item B<hold>: I<boolean>
963		1127
964	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1128	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
965	will not immediately destroy its window when the program executed within	1129	will not immediately destroy its window when the program executed within
966	it exits. Instead, it will wait till it is being killed or closed by the	1130	it exits. Instead, it will wait till it is being killed or closed by the
967	user.	1131	user.
		1132
		1133	=item B<chdir>: I<path>
		1134
		1135	Sets the working directory for the shell (or the command specified via
		1136	B<-e>). The I<path> must be an absolute path and it must exist for
		1137	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1138	directory will be used; option B<-cd>.
968		1139
969	=item B<keysym.>I<sym>: I<string>	1140	=item B<keysym.>I<sym>: I<string>
970		1141
971	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1142	Compile I<frills>: Associate I<string> with keysym I<sym>. The
972	intervening resource name B<keysym.> cannot be omitted.	1143	intervening resource name B<keysym.> cannot be omitted.
…		…
986	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1157	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
987	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1158	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
988	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1159	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
989	performed in an exact manner; however, the closest match is assured.	1160	performed in an exact manner; however, the closest match is assured.
990		1161
991	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1162	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
992	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1163	number), see RESOURCES in C<man 7 X> for further details.
993	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
994	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
995	can start or end with whitespace.
996
997	Please note that you need to double the C<\> when using
998	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
999	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1000	@@RXVT_NAME@@'s own processing).
1001		1164
1002	You can define a range of keysyms in one shot by providing a I<string>	1165	You can define a range of keysyms in one shot by providing a I<string>
1003	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1166	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1004	should be a character not used by the strings.	1167	should be a character not used by the strings.
1005		1168
1006	Its usage can be demonstrated by an example:	1169	Its usage can be demonstrated by an example:
1007		1170
1008	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1171	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1009		1172
1010	The above line is equivalent to the following three lines:	1173	The above line is equivalent to the following three lines:
1011		1174
1012	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1175	URxvt.keysym.Meta-Control-0x61: \033<a>
1013	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1176	URxvt.keysym.Meta-Control-0x62: \033<b>
1014	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1177	URxvt.keysym.Meta-Control-0x63: \033<c>
1015		1178
1016	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1179	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1017	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1180	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1018	example the following means "change the current locale to C<zh_CN.GBK>	1181	example the following means "change the current locale to C<zh_CN.GBK>
1019	when Control-Meta-c is being pressed":	1182	when Control-Meta-c is being pressed":
1020		1183
1021	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1184	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1022		1185
		1186	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1187	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1188	manpage. For example, the F<selection> extension (activated via
		1189	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1190
		1191	URxvt.keysym.M-C-c: perl:selection:rot13
		1192
1023	Due the the large number of modifier combinations, a defined key mapping	1193	Due the the large number of modifier combinations, a defined key mapping
1024	will match if at I<at least> the specified identifiers are being set, and	1194	will match if I<at least> the specified identifiers are being set, and
1025	no other key mappings with those and more bits are being defined. That	1195	no other key mappings with those and more bits are being defined. That
1026	means that defining a key map for C<a> will automatically provide	1196	means that defining a key map for C<a> will automatically provide
1027	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1197	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1028	mappings themselves.	1198	mappings themselves.
1029		1199
…		…
1049	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1219	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1050	info):	1220	info):
1051		1221
1052	URxvt.keysym.M-C-3: command:\033[8;25;80t	1222	URxvt.keysym.M-C-3: command:\033[8;25;80t
1053	URxvt.keysym.M-C-4: command:\033[8;48;110t	1223	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1224
		1225	=item B<perl-ext-common>: I<string>
		1226
		1227	=item B<perl-ext>: I<string>
		1228
		1229	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1230	use in this terminal instance; option B<-pe>.
		1231
		1232	Extension names can be prefixed with a C<-> sign to prohibit using
		1233	them. This can be useful to selectively disable some extensions loaded
		1234	by default, or specified via the C<perl-ext-common> resource. For
		1235	example, C<default,-selection> will use all the default extension except
		1236	C<selection>.
		1237
		1238	Extension names can also be followed by an argument in angle brackets
		1239	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1240	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1241	multiple times with different arguments will pass multiple arguments to
		1242	the extension.
		1243
		1244	Each extension is looked up in the library directories, loaded if
		1245	necessary, and bound to the current terminal instance.
		1246
		1247	If both of these resources are the empty string, then the perl
		1248	interpreter will not be initialized. The idea behind two options is that
		1249	B<perl-ext-common> will be used for extensions that should be available to
		1250	all instances, while B<perl-ext> is used for specific instances.
		1251
		1252	=item B<perl-eval>: I<string>
		1253
		1254	Perl code to be evaluated when all extensions have been registered. See
		1255	the @@RXVT_NAME@@perl(3) manpage.
		1256
		1257	=item B<perl-lib>: I<path>
		1258
		1259	Colon-separated list of additional directories that hold extension
		1260	scripts. When looking for extensions specified by the C<perl> resource,
		1261	@@RXVT_NAME@@ will first look in these directories and then in
		1262	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1263
		1264	See the @@RXVT_NAME@@perl(3) manpage.
		1265
		1266	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1267
		1268	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1269	details.
		1270
		1271	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1272
		1273	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1274	for details.
		1275
		1276	=item B<searchable-scrollback:> I<keysym>
		1277
		1278	Sets the hotkey that starts the incremental scrollback buffer search
		1279	(default: C<M-s>).
		1280
		1281	=item B<urlLauncher>: I<string>
		1282
		1283	Specifies the program to be started with a URL argument. Used by the
		1284	C<selection-popup> and C<matcher> perl extensions.
		1285
		1286	=item B<transient-for>: I<windowid>
		1287
		1288	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1289
		1290	=item B<override-redirect>: I<boolean>
		1291
		1292	Compile I<frills>: Sets override-redirect for the terminal window, making
		1293	it almost invisible to window managers; option B<-override-redirect>.
		1294
		1295	=item B<iso14755:> I<boolean>
		1296
		1297	Turn on/off ISO 14755 (default enabled).
		1298
		1299	=item B<iso14755_52:> I<boolean>
		1300
		1301	Turn on/off ISO 14755 5.2 mode (default enabled).
1054		1302
1055	=back	1303	=back
1056		1304
1057	=head1 THE SCROLLBAR	1305	=head1 THE SCROLLBAR
1058		1306
…		…
1077	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1325	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1078	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1326	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1079	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1327	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1080	respectively.	1328	respectively.
1081		1329
1082	=head1 TEXT SELECTION AND INSERTION	1330	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1083		1331
1084	The behaviour of text selection and insertion mechanism is similar to	1332	The behaviour of text selection and insertion/pasting mechanism is similar
1085	I<xterm>(1).	1333	to I<xterm>(1).
1086		1334
1087	=over 4	1335	=over 4
1088		1336
1089	=item B<Selection>:	1337	=item B<Selecting>:
1090		1338
1091	Left click at the beginning of the region, drag to the end of the region	1339	Left click at the beginning of the region, drag to the end of the region
1092	and release; Right click to extend the marked region; Left double-click	1340	and release; Right click to extend the marked region; Left double-click
1093	to select a word; Left triple-click to select the entire logical line	1341	to select a word; Left triple-click to select the entire logical line
1094	(which can span multiple screen lines), unless modified by resource	1342	(which can span multiple screen lines), unless modified by resource
…		…
1098	(Compile: I<frills>) will create a rectangular selection instead of a	1346	(Compile: I<frills>) will create a rectangular selection instead of a
1099	normal one. In this mode, every selected row becomes its own line in the	1347	normal one. In this mode, every selected row becomes its own line in the
1100	selection, and trailing whitespace is visually underlined and removed from	1348	selection, and trailing whitespace is visually underlined and removed from
1101	the selection.	1349	the selection.
1102		1350
1103	=item B<Insertion>:	1351	=item B<Pasting>:
1104		1352
1105	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1353	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1106	an B<@@RXVT_NAME@@> window causes the current text selection to be	1354	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1107	inserted as if it had been typed on the keyboard.	1355	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1356
		1357	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1358	inserted too.
1108		1359
1109	=back	1360	=back
1110		1361
1111	=head1 CHANGING FONTS	1362	=head1 CHANGING FONTS
1112		1363
1113	Changing fonts (or font sizes, respectively) via the keypad is not yet	1364	Changing fonts (or font sizes, respectively) via the keypad is not yet
1114	supported in rxvt-unicode. Bug me if you need this.	1365	supported in rxvt-unicode. Bug me if you need this.
1115		1366
1116	You can, however, switch fonts at runtime using escape sequences (and	1367	You can, however, switch fonts at runtime using escape sequences, e.g.:
1117	therefore using the menubar), e.g.:
1118		1368
1119	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1369	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1370
		1371	You can use keyboard shortcuts, too:
		1372
		1373	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1374	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1120		1375
1121	rxvt-unicode will automatically re-apply these fonts to the output so far.	1376	rxvt-unicode will automatically re-apply these fonts to the output so far.
1122		1377
1123	=head1 ISO 14755 SUPPORT	1378	=head1 ISO 14755 SUPPORT
1124		1379
1125	ISO 14755 is a standard for entering and viewing unicode characters	1380	ISO 14755 is a standard for entering and viewing unicode characters
1126	and character codes using the keyboard. It consists of 4 parts. The	1381	and character codes using the keyboard. It consists of 4 parts. The
1127	first part is available rxvt-unicode has been compiled with	1382	first part is available if rxvt-unicode has been compiled with
1128	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1383	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1129	with C<--enable-iso14755>.	1384	with C<--enable-iso14755>.
1130		1385
1131	=over 4	1386	=over 4
1132		1387
…		…
1152	This mode lets you input characters representing the keycap symbols of	1407	This mode lets you input characters representing the keycap symbols of
1153	your keyboard, if representable in the current locale encoding.	1408	your keyboard, if representable in the current locale encoding.
1154		1409
1155	Start by pressing C<Control> and C<Shift> together, then releasing	1410	Start by pressing C<Control> and C<Shift> together, then releasing
1156	them. The next special key (cursor keys, home etc.) you enter will not	1411	them. The next special key (cursor keys, home etc.) you enter will not
1157	invoke it's usual function but instead will insert the corresponding	1412	invoke its usual function but instead will insert the corresponding
1158	keycap symbol. The symbol will only be entered when the key has been	1413	keycap symbol. The symbol will only be entered when the key has been
1159	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1414	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1160	C<ISO Level 2 Switch>, although your intention might have been to enter a	1415	C<ISO Level 2 Switch>, although your intention might have been to enter a
1161	reverse tab (Shift-Tab).	1416	reverse tab (Shift-Tab).
1162		1417
…		…
1190	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1445	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1191	it can be seen via the I<who(1)> command, and can accept messages. To	1446	it can be seen via the I<who(1)> command, and can accept messages. To
1192	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1447	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1193	on some systems or setgid to root or to some other group on others.	1448	on some systems or setgid to root or to some other group on others.
1194		1449
1195	=head1 COLORS AND GRAPHICS	1450	=head1 COLOURS AND GRAPHICS
1196		1451
1197	In addition to the default foreground and background colours,	1452	In addition to the default foreground and background colours,
1198	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1453	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1199	high-intensity bold/blink versions of the same). Here is a list of the	1454	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1200	colours with their B<rgb.txt> names.	1455	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1456	cube plus a 8 (24) colour greyscale ramp.
		1457
		1458	Here is a list of the ANSI colours with their names.
1201		1459
1202	=begin table	1460	=begin table
1203		1461
1204	B<color0> (black) = Black	1462	B<color0> (black) = Black
1205	B<color1> (red) = Red3	1463	B<color1> (red) = Red3
…		…
1225	It is also possible to specify the colour values of B<foreground>,	1483	It is also possible to specify the colour values of B<foreground>,
1226	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1484	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1227	a number 0-15, as a convenient shorthand to reference the colour name of	1485	a number 0-15, as a convenient shorthand to reference the colour name of
1228	color0-color15.	1486	color0-color15.
1229		1487
		1488	The following text gives values for the standard 88 colour mode (and
		1489	values for the 256 colour mode in parentheses).
		1490
		1491	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1492
		1493	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1494	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1495
		1496	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1497	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1498	the RGB cube.
		1499
		1500	Together, all those colours implement the 88 (256) colour xterm
		1501	colours. Only the first 16 can be changed using resources currently, the
		1502	rest can only be changed via command sequences ("escape codes").
		1503
		1504	Applications are advised to use terminfo or command sequences to discover
		1505	number and RGB values of all colours (yes, you can query this...).
		1506
1230	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1507	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1231	always swapping the foreground/background colours. This is in contrast to	1508	always swapping the foreground/background colours. This is in contrast to
1232	I<xterm>(1) where the colours are only swapped if they have not otherwise	1509	I<xterm>(1) where the colours are only swapped if they have not otherwise
1233	been specified. For example,	1510	been specified. For example,
1234		1511
		1512	@@RXVT_NAME@@ -fg Black -bg White -rv
		1513
		1514	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1515	White.
		1516
		1517	=head2 ALPHA CHANNEL SUPPORT
		1518
		1519	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1520	their act together, rxvt-unicode will do it's own alpha channel management:
		1521
		1522	You can prefix any colour with an opaqueness percentage enclosed in
		1523	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1524	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1525	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1526	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1527	is the recommended format to specify transparency values, and works with
		1528	all ways to specify a colour.
		1529
		1530	For complete control, rxvt-unicode also supports
		1531	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1532	specifications, where the additional C<aaaa> component specifies opacity
		1533	(alpha) values. The minimum value of C<0000> is completely transparent,
		1534	while C<ffff> is completely opaque). The two example colours from
		1535	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1536	C<rgba:0000/ff00/0000/f332>.
		1537
		1538	You probably need to specify B<"-depth 32">, too, to force a visual with
		1539	alpha channels, and have the luck that your X-server uses ARGB pixel
		1540	layout, as X is far from just supporting ARGB visuals out of the box, and
		1541	rxvt-unicode just fudges around.
		1542
		1543	For example, the following selects an almost completely transparent black
		1544	background, and an almost opaque pink foreground:
		1545
		1546	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1547
		1548	When not using a background image, then the interpretation of the
		1549	alpha channel is up to your compositing manager (most interpret it as
		1550	transparency of course).
		1551
		1552	When using a background pixmap or pseudo-transparency, then the background
		1553	colour will always behave as if it were completely transparent (so the
		1554	background image shows instead), regardless of how it was specified, while
		1555	other colours will either be transparent as specified (the background
		1556	image will show through) on servers supporting the RENDER extension, or
		1557	fully opaque on servers not supporting the RENDER EXTENSION.
		1558
		1559	Please note that due to bugs in Xft, specifying alpha values might result
		1560	in garbage being displayed when the X-server does not support the RENDER
		1561	extension.
		1562
		1563	=head1 ENVIRONMENT
		1564
		1565	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1566
1235	=over 4	1567	=over 4
1236		1568
1237	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1238
1239	would yield White on Black, while on I<xterm>(1) it would yield Black
1240	on White.
1241
1242	=back
1243
1244	=head1 ENVIRONMENT
1245
1246	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1247
1248	=over 4
1249
1250	=item B<TERM>	1569	=item B<TERM>
1251		1570
1252	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1571	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1253	resources or on the commandline.	1572	resources or on the command line.
1254		1573
1255	=item B<COLORTERM>	1574	=item B<COLORTERM>
1256		1575
1257	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1576	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1258	compiled with XPM support, and optionally with the added extension	1577	compiled with background image support, and optionally with the added
1259	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1578	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1579	screen.
1260		1580
1261	=item B<COLORFGBG>	1581	=item B<COLORFGBG>
1262		1582
1263	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1583	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1264	the colour code used as default foreground/text colour (or the string	1584	the colour code used as default foreground/text colour (or the string
1265	C<default> to indicate that the default-colour escape sequence is to be	1585	C<default> to indicate that the default-colour escape sequence is to be
1266	used), C<bg> is the colour code used as default background colour (or the	1586	used), C<bg> is the colour code used as default background colour (or the
1267	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1587	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1268	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1588	was compiled with background image support. Libraries like C<ncurses>
1269	(and do) use this information to optimize screen output.	1589	and C<slang> can (and do) use this information to optimize screen output.
1270		1590
1271	=item B<WINDOWID>	1591	=item B<WINDOWID>
1272		1592
1273	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1593	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1274	window, which usually has subwindows for the scrollbar, the terminal	1594	window, which usually has subwindows for the scrollbar, the terminal
…		…
1280	C<--with-terminfo=PATH>.	1600	C<--with-terminfo=PATH>.
1281		1601
1282	=item B<DISPLAY>	1602	=item B<DISPLAY>
1283		1603
1284	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1604	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1285	display in it's child processes.	1605	display in its child processes if C<-display> isn't used to override. It
		1606	defaults to C<:0> if it doesn't exist.
1286		1607
1287	=item B<SHELL>	1608	=item B<SHELL>
1288		1609
1289	The shell to be used for command execution, defaults to C</bin/sh>.	1610	The shell to be used for command execution, defaults to C</bin/sh>.
1290
1291	=item B<RXVTPATH>
1292
1293	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1294	files.
1295
1296	=item B<PATH>
1297
1298	Used in the same way as C<RXVTPATH>.
1299		1611
1300	=item B<RXVT_SOCKET>	1612	=item B<RXVT_SOCKET>
1301		1613
1302	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1614	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1303	@@RXVT_NAME@@d(1).	1615	@@RXVT_NAME@@d(1).
1304		1616
1305	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1617	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1306		1618
1307	=item B<HOME>	1619	=item B<HOME>
1308		1620
1309	Used to locate the default directory for the unix domain socket for	1621	Used to locate the default directory for the unix domain socket for
1310	daemon communications and to locate various resource files (such as	1622	daemon communications and to locate various resource files (such as
1311	C<.Xdefaults>)	1623	C<.Xdefaults>)
1312		1624
1313	=item B<XAPPLRESDIR>	1625	=item B<XAPPLRESDIR>
1314		1626
1315	Directory where various X resource files are being located.	1627	Directory where application-specific X resource files are located.
1316		1628
1317	=item B<XENVIRONMENT>	1629	=item B<XENVIRONMENT>
1318		1630
1319	If set and accessible, gives the name of a X resource file to be loaded by	1631	If set and accessible, gives the name of a X resource file to be loaded by
1320	@@RXVT_NAME@@.	1632	@@RXVT_NAME@@.
…		…
1325		1637
1326	=over 4	1638	=over 4
1327		1639
1328	=item B</usr/lib/X11/rgb.txt>	1640	=item B</usr/lib/X11/rgb.txt>
1329		1641
1330	Color names.	1642	Colour names.
1331		1643
1332	=back	1644	=back
1333		1645
1334	=head1 SEE ALSO	1646	=head1 SEE ALSO
1335		1647
…		…
1341		1653
1342	=item Project Coordinator	1654	=item Project Coordinator
1343		1655
1344	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1656	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1345		1657
1346	L<http://software.schmorp.de/#rxvt-unicode>	1658	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1347		1659
1348	=back	1660	=back
1349		1661
1350	=head1 AUTHORS	1662	=head1 AUTHORS
1351		1663
…		…
1373		1685
1374	Project Coordinator (changes.txt 2.21a to 2.4.5)	1686	Project Coordinator (changes.txt 2.21a to 2.4.5)
1375		1687
1376	=item Geoff Wing L<< <gcw@pobox.com> >>	1688	=item Geoff Wing L<< <gcw@pobox.com> >>
1377		1689
1378	Rewrote screen display and text selection routines. Project Coordinator	1690	Rewrote screen display and text selection routines.
		1691
1379	(changes.txt 2.4.6 - rxvt-unicode)	1692	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1380		1693
1381	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1694	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1382		1695
1383	Forked rxvt-unicode, rewrote most of the display code and internal	1696	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1384	character handling to store text in unicode, improve xterm	1697	extension, random hacks, numerous bugfixes and extensions.
1385	compatibility and apply numerous other bugfixes and extensions.
1386		1698
1387	Project Coordinator (Changes 1.0 -)	1699	Project Coordinator (Changes 1.0 -)
1388		1700
		1701	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1702
		1703	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1704
1389	=back	1705	=back
1390		1706

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.76 by root, Sat Dec 31 16:06:48 2005 UTC vs. Revision 1.201 by sf-exg, Wed Aug 10 07:34:35 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.76 by root, Sat Dec 31 16:06:48 2005 UTC vs.
Revision 1.201 by sf-exg, Wed Aug 10 07:34:35 2011 UTC