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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.84 by root, Wed Jan 4 05:35:34 2006 UTC vs. Revision 1.198 by sf-exg, Tue Aug 9 18:41:31 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.84 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.198 by sf-exg, Tue Aug 9 18:41:31 2011 UTC