ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.32 by root, Sat Oct 9 11:18:12 2004 UTC vs.
Revision 1.166 by root, Fri Oct 10 13:23:56 2008 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	asked questions and answer to them and some common problems.	23	frequently asked questions and answer to them and some common
		24	problems. That document is also accessible on the World-Wide-Web at
		25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
21		26
22	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
23		28
24	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
25	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
26	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
27	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
28	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
29	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
30	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
31	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
32	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
33	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
34	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
35	change.	40	change.
36		41
37	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
38	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
39	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
40	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
41	another for japanese.	46	another for japanese.
42		47
43	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
44	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
45	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
46	to choose any font for any script freely.	51	to choose any font for any script freely.
47		52
48	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
49	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
50	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
51	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
52		57
53	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
54	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
55	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
56	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
57	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
58	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
60		65
61	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
62	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
63	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
64		69
65	=head1 OPTIONS	70	=head1 OPTIONS
66		71
67	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
…		…
87		92
88	Print out a message describing available options.	93	Print out a message describing available options.
89		94
90	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
91		96
92	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>
93	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
94	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]
95		110
96	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
97		112
98	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
99		114
…		…
101		116
102	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
103		118
104	=item B<-j>|B<+j>	119	=item B<-j>|B<+j>
105		120
106	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
107		122
108	=item B<-ip>|B<+ip>	123	=item B<-ss>|B<+ss>
109		124
110	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>.
111	B<-tr>; resource B<inheritPixmap>.	126
		127	=item B<-tr>|B<+tr>
		128
		129	Turn on/off illusion of a transparent window background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
		133
		134	I<Please address all transparency related issues to Sasha Vasko at
		135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
112		136
113	=item B<-fade> I<number>	137	=item B<-fade> I<number>
114		138
115	Fade the text by the given percentage when focus is lost.	139	Fade the text by the given percentage when focus is lost. Small values
		140	fade a little only, 100 completely replaces all colours by the fade
		141	colour; resource B<fading>.
		142
		143	=item B<-fadecolor> I<colour>
		144
		145	Fade to this colour when fading is used (see B<-fade>). The default colour
		146	is opaque black. resource B<fadeColor>.
116		147
117	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
118		149
119	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	151	transparency is enabled with B<-tr>. This only works for
		152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
121	option that can be used to brighten or darken the image in addition to	153	used to brighten or darken the image in addition to tinting it.
122	tinting it.	154	Please note that certain tint colours can be applied on the server-side,
		155	thus yielding performance gain of two orders of magnitude. These colours are:
		156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		157	pure black and pure white colors essentially mean no tinting; resource
		158	I<tintColor>. Example:
123		159
124	=item B<-sh>	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
125		161
		162	=item B<-sh> I<number>
		163
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
127	background image in addition to tinting it (i.e. B<-tint> must be	165	background image in addition to (or instead of) tinting it;
128	specified, too).	166	resource I<shading>.
		167
		168	=item B<-blt> I<string>
		169
		170	Specify background blending type. If background pixmap is specified
		171	at the same time as transparency - such pixmap will be blended over
		172	transparency image, using method specified. Supported values are :
		173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		177
		178	=item B<-blr> I<HxV>
		179
		180	Apply Gaussian Blur with the specified radii to the transparent
		181	background image. If single number is specified - both vertical and
		182	horizontal radii are considered to be the same. Setting one of the
		183	radii to 1 and another to a large number creates interesting effects
		184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		185	resource I<blurRadius>.
129		186
130	=item B<-bg> I<colour>	187	=item B<-bg> I<colour>
131		188
132	Window background colour; resource B<background>.	189	Window background colour; resource B<background>.
133		190
134	=item B<-fg> I<colour>	191	=item B<-fg> I<colour>
135		192
136	Window foreground colour; resource B<foreground>.	193	Window foreground colour; resource B<foreground>.
137		194
138	=item B<-pixmap> I<file[;geom]>	195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
139		196
140	Compile I<XPM>: Specify XPM file for the background and also optionally	197	Compile I<afterimage>: Specify image file for the background and also
141	specify its scaling with a geometry string. Note you may need to add	198	optionally specify its scaling with a geometry string. Note you may need to
142	quotes to avoid special shell interpretation of the `;' in the	199	add quotes to avoid special shell interpretation of the C<;> in the
143	command-line; resource B<backgroundPixmap>.	200	command-line; for more details see resource B<backgroundPixmap>.
144		201
145	=item B<-cr> I<colour>	202	=item B<-cr> I<colour>
146		203
147	The cursor colour; resource B<cursorColor>.	204	The cursor colour; resource B<cursorColor>.
148		205
…		…
160	resource B<borderColor>.	217	resource B<borderColor>.
161		218
162	=item B<-fn> I<fontlist>	219	=item B<-fn> I<fontlist>
163		220
164	Select the fonts to be used. This is a comma separated list of font names	221	Select the fonts to be used. This is a comma separated list of font names
165	that are used in turn when trying to display Unicode characters. The	222	that are checked in order when trying to find glyphs for characters. The
166	first font defines the cell size for characters; other fonts might be	223	first font defines the cell size for characters; other fonts might be
167	smaller, but not (in general) larger. A reasonable default font list is	224	smaller, but not (in general) larger. A (hopefully) reasonable default
168	always appended to it. See resource B<font> for details.	225	font list is always appended to it. See resource B<font> for more details.
		226
		227	In short, to specify an X11 core font, just specify its name or prefix it
		228	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		229	e.g.:
		230
		231	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		232	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
169		233
170	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	234	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
171	section of @@RXVT_NAME@@(7).	235	section of @@RXVT_NAME@@(7).
172		236
173	=item B<-fb> I<fontlist>	237	=item B<-fb> I<fontlist>
174		238
175	Compile font-styles: The bold font list to use when bold characters are to	239	Compile I<font-styles>: The bold font list to use when B<bold> characters
176	be printed. See resource B<boldFont> for details.	240	are to be printed. See resource B<boldFont> for details.
177		241
178	=item B<-fi> I<fontlist>	242	=item B<-fi> I<fontlist>
179		243
180	Compile font-styles: The italic font list to use when bold characters are to	244	Compile I<font-styles>: The italic font list to use when I<italic>
181	be printed. See resource B<italicFont> for details.	245	characters are to be printed. See resource B<italicFont> for details.
182		246
183	=item B<-fbi> I<fontlist>	247	=item B<-fbi> I<fontlist>
184		248
185	Compile font-styles: The bold italic font list to use when bold characters are to	249	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
186	be printed. See resource B<boldItalicFont> for details.	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
		251	for details.
		252
		253	=item B<-is>|B<+is>
		254
		255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
		256	foreground/background (default). See resource B<intensityStyles> for
		257	details.
187		258
188	=item B<-name> I<name>	259	=item B<-name> I<name>
189		260
190	Specify the application name under which resources are to be obtained,	261	Specify the application name under which resources are to be obtained,
191	rather than the default executable file name. Name should not contain	262	rather than the default executable file name. Name should not contain
…		…
207		278
208	=item B<-sb>|B<+sb>	279	=item B<-sb>|B<+sb>
209		280
210	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
211		282
		283	=item B<-sr>|B<+sr>
		284
		285	Put scrollbar on right/left; resource B<scrollBar_right>.
		286
		287	=item B<-st>|B<+st>
		288
		289	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		290	resource B<scrollBar_floating>.
		291
212	=item B<-si>|B<+si>	292	=item B<-si>|B<+si>
213		293
214	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
215	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
216		296
…		…
223		303
224	Turn on/off scrolling with the scrollback buffer as new lines appear.	304	Turn on/off scrolling with the scrollback buffer as new lines appear.
225	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
226	B<scrollWithBuffer>.	306	B<scrollWithBuffer>.
227		307
228	=item B<-sr>|B<+sr>
229
230	Put scrollbar on right/left; resource B<scrollBar_right>.
231
232	=item B<-st>|B<+st>	308	=item B<-ptab>|B<+ptab>
233		309
234	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	310	If enabled (default), "Horizontal Tab" characters are being stored as
235	resource B<scrollBar_floating>.	311	actual wide characters in the screen buffer, which makes it possible to
		312	select and paste them. Since a horizontal tab is a cursor movement and
		313	not an actual glyph, this can sometimes be visually annoying as the cursor
		314	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
236		315
237	=item B<-bc>|B<+bc>	316	=item B<-bc>|B<+bc>
238		317
239	Blink the cursor; resource B<cursorBlink>.	318	Blink the cursor; resource B<cursorBlink>.
240		319
…		…
261		340
262	=item B<-bl>	341	=item B<-bl>
263		342
264	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	343	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
265	if honoured by the WM, the rxvt-unicode window will not have window	344	if honoured by the WM, the rxvt-unicode window will not have window
266	decorations; resource B<borderLess>.	345	decorations; resource B<borderLess>. If the window manager does not
		346	support MWM hints (e.g. kwin), enables override-redirect mode.
		347
		348	=item B<-override-redirect>
		349
		350	Compile I<frills>: Sets override-redirect on the window; resource
		351	B<override-redirect>.
		352
		353	=item B<-sbg>
		354
		355	Compile I<frills>: Disable the usage of the built-in block graphics/line
		356	drawing characters and just rely on what the specified fonts provide. Use
		357	this if you have a good font and want to use its block graphic glyphs;
		358	resource B<skipBuiltinGlyphs>.
267		359
268	=item B<-lsp> I<number>	360	=item B<-lsp> I<number>
269		361
270	Compile I<linespace>: Lines (pixel height) to insert between each row	362	Compile I<frills>: Lines (pixel height) to insert between each row of
271	of the display; resource B<linespace>.	363	the display. Useful to work around font rendering problems; resource
		364	B<lineSpace>.
272		365
273	=item B<-tn> I<termname>	366	=item B<-tn> I<termname>
274		367
275	This option specifies the name of the terminal type to be set in the	368	This option specifies the name of the terminal type to be set in the
276	B<TERM> environment variable. This terminal type must exist in the	369	B<TERM> environment variable. This terminal type must exist in the
…		…
285	given on the command line. If this option is used, it must be the last	378	given on the command line. If this option is used, it must be the last
286	on the command-line. If there is no B<-e> option then the default is to	379	on the command-line. If there is no B<-e> option then the default is to
287	run the program specified by the B<SHELL> environment variable or,	380	run the program specified by the B<SHELL> environment variable or,
288	failing that, I<sh(1)>.	381	failing that, I<sh(1)>.
289		382
		383	Please note that you must specify a program with arguments. If you want to
		384	run shell commands, you have to specify the shell, like this:
		385
		386	@@RXVT_NAME@@ -e sh -c "shell commands"
		387
290	=item B<-title> I<text>	388	=item B<-title> I<text>
291		389
292	Window title (B<-T> still respected); the default title is the basename	390	Window title (B<-T> still respected); the default title is the basename
293	of the program specified after the B<-e> option, if any, otherwise the	391	of the program specified after the B<-e> option, if any, otherwise the
294	application name; resource B<title>.	392	application name; resource B<title>.
…		…
312		410
313	Compile I<XIM>: input method name. resource B<inputMethod>.	411	Compile I<XIM>: input method name. resource B<inputMethod>.
314		412
315	=item B<-imlocale> I<string>	413	=item B<-imlocale> I<string>
316		414
317	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	415	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
318	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	416	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
319	extension to be able to input japanese characters while staying in	417	input extension to be able to input japanese characters while staying in
320	another locale.	418	another locale. resource B<imLocale>.
		419
		420	=item B<-imfont> I<fontset>
		421
		422	Set the font set to use for the X Input Method, see resource B<imFont>
		423	for more info.
		424
		425	=item B<-tcw>
		426
		427	Change the meaning of triple-click selection with the left mouse
		428	button. Only effective when the original (non-perl) selection code is
		429	in-use. Instead of selecting a full line it will extend the selection to
		430	the end of the logical line only. resource B<tripleclickwords>.
321		431
322	=item B<-insecure>	432	=item B<-insecure>
323		433
324	Enable "insecure" mode, which currently enables most of the escape	434	Enable "insecure" mode, which currently enables most of the escape
325	sequences that echo strings. See the resource B<insecure> for more	435	sequences that echo strings. See the resource B<insecure> for more
…		…
339	=item B<-ssr>|B<+ssr>	449	=item B<-ssr>|B<+ssr>
340		450
341	Turn on/off secondary screen scroll (default enabled); resource	451	Turn on/off secondary screen scroll (default enabled); resource
342	B<secondaryScroll>.	452	B<secondaryScroll>.
343		453
		454	=item B<-hold>|B<+hold>
		455
		456	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		457	will not immediately destroy its window when the program executed within
		458	it exits. Instead, it will wait till it is being killed or closed by the
		459	user; resource B<hold>.
		460
		461	=item B<-cd> I<path>
		462
		463	Sets the working directory for the shell (or the command specified via
		464	B<-e>). The I<path> must be an absolute path and it must exist for
		465	@@RXVT_NAME@@ to start; resource B<chdir>.
		466
344	=item B<-xrm> I<resourcestring>	467	=item B<-xrm> I<string>
345		468
346	No effect on rxvt-unicode. Simply passes through an argument to be made	469	Works like the X Toolkit option of the same name, by adding the I<string>
347	available in the instance's argument list. Appears in I<WM_COMMAND> in	470	as if it were specified in a resource file. Resource values specified this
348	some window managers.	471	way take precedence over all other resource specifications.
		472
		473	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		474	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		475	options can be specified as long-options on the commandline, so use
		476	of B<-xrm> is mostly limited to cases where you want to specify other
		477	resources (e.g. for input methods) or for compatibility with other
		478	programs.
		479
		480	=item B<-keysym.>I<sym> I<string>
		481
		482	Remap a key symbol. See resource B<keysym>.
		483
		484	=item B<-embed> I<windowid>
		485
		486	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		487	which enables applications to easily embed a terminal.
		488
		489	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		490	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		491	quite a bit, so don't expect it to keep some specific state. It's best to
		492	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		493
		494	The window will not be destroyed when @@RXVT_NAME@@ exits.
		495
		496	It might be useful to know that @@RXVT_NAME@@ will not close file
		497	descriptors passed to it (except for stdin/out/err, of course), so you
		498	can use file descriptors to communicate with the programs within the
		499	terminal. This works regardless of whether the C<-embed> option was used or
		500	not.
		501
		502	Here is a short Gtk2-perl snippet that illustrates how this option can be
		503	used (a longer example is in F<doc/embed>):
		504
		505	my $rxvt = new Gtk2::Socket;
		506	$rxvt->signal_connect_after (realize => sub {
		507	my $xid = $_[0]->window->get_xid;
		508	system "@@RXVT_NAME@@ -embed $xid &";
		509	});
		510
		511	=item B<-pty-fd> I<file descriptor>
		512
		513	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		514	pair but instead use the given file descriptor as the tty master. This is
		515	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		516	without having to run a program within it.
		517
		518	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		519	entries and will not tinker with pty/tty permissions - you have to do that
		520	yourself if you want that.
		521
		522	As an extremely special case, specifying C<-1> will completely suppress
		523	pty/tty operations, which is probably only useful in conjunction with some
		524	perl extension that manages the terminal.
		525
		526	Here is a example in perl that illustrates how this option can be used (a
		527	longer example is in F<doc/pty-fd>):
		528
		529	use IO::Pty;
		530	use Fcntl;
		531
		532	my $pty = new IO::Pty;
		533	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		534	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		535	close $pty;
		536
		537	# now communicate with rxvt
		538	my $slave = $pty->slave;
		539	while (<$slave>) { print $slave "got <$_>\n" }
		540
		541	=item B<-pe> I<string>
		542
		543	Comma-separated list of perl extension scripts to use (or not to use) in
		544	this terminal instance. See resource B<perl-ext> for details.
349		545
350	=back	546	=back
351		547
352	=head1 RESOURCES (available also as long-options)	548	=head1 RESOURCES
353		549
354	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	550	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
355	options) compiled into your version.	551	options) compiled into your version. All resources are also available as
		552	long-options.
356		553
357	There are two different methods that @@RXVT_NAME@@ can use to get the	554	You can set and change the resources using X11 tools like B<xrdb>. Many
358	Xresource data: using the X libraries (Xrm*-functions) or internal	555	distribution do also load settings from the B<~/.Xresources> file when X
359	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	556	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
360	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	557	with later settings overwriting earlier ones:
361	resources using X11 tools like B<xset>. Many distribution do also load
362	settings from the B<~/.Xresources> file when X starts.
363		558
364	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	559	1. system-wide app-defaults file, either locale-dependent OR global
365	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	560	2. app-defaults file in $XAPPLRESDIR
366	set in XAPPLOADDIR/URxvt (compile-time defined: usually	561	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
367	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	562	4. SCREEN_RESOURCES for the current screen
368	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	563	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		564	6. resources specified via -xrm on the commandline
		565
369	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	566	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
370	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	567	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
371	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	568	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
372	easily configured, while the class name B<URxvt> allows resources	569	configured, while the class name B<URxvt> allows resources unique to
373	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	570	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
374	shared between different B<@@RXVT_NAME@@> configurations. If no	571	configurations. If no resources are specified, suitable defaults will
375	resources are specified, suitable defaults will be used. Command-line	572	be used. Command-line arguments can be used to override resource
376	arguments can be used to override resource settings. The following	573	settings. The following resources are supported (you might want to
377	resources are allowed:	574	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		575	extensions not documented here):
378		576
379	=over 4	577	=over 4
		578
		579	=item B<depth:> I<bitdepth>
		580
		581	Compile I<xft>: Attempt to find a visual with the given bit depth;
		582	option B<-depth>.
		583
		584	=item B<buffered:> I<boolean>
		585
		586	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		587	On some card/driver combination enabling it slightly decreases
		588	performance, on most it greatly helps it. The slowdown is small, so it
		589	should normally be enabled.
380		590
381	=item B<geometry:> I<geom>	591	=item B<geometry:> I<geom>
382		592
383	Create the window with the specified X window geometry [default 80x24];	593	Create the window with the specified X window geometry [default 80x24];
384	option B<-geometry>.	594	option B<-geometry>.
…		…
412		622
413	=item B<colorIT:> I<colour>	623	=item B<colorIT:> I<colour>
414		624
415	Use the specified colour to display bold or italic characters when the	625	Use the specified colour to display bold or italic characters when the
416	foreground colour is the default. If font styles are not available	626	foreground colour is the default. If font styles are not available
417	(Compile styles) and this option is unset, reverse video is used instead.	627	(Compile I<styles>) and this option is unset, reverse video is used instead.
418		628
419	=item B<colorUL:> I<colour>	629	=item B<colorUL:> I<colour>
420		630
421	Use the specified colour to display underlined characters when the	631	Use the specified colour to display underlined characters when the
422	foreground colour is the default.	632	foreground colour is the default.
423		633
424	=item B<colorRV:> I<colour>	634	=item B<colorRV:> I<colour>
425		635
426	Use the specified colour as the background for reverse video	636	Use the specified colour as the background for reverse video characters
427	characters.	637	when OPTION_HC is disabled (--disable-frills).
		638
		639	=item B<underlineColor:> I<colour>
		640
		641	If set, use the specified colour as the colour for the underline
		642	itself. If unset, use the foreground colour.
428		643
429	=item B<cursorColor:> I<colour>	644	=item B<cursorColor:> I<colour>
430		645
431	Use the specified colour for the cursor. The default is to use the	646	Use the specified colour for the cursor. The default is to use the
432	foreground colour; option B<-cr>.	647	foreground colour; option B<-cr>.
…		…
443	option B<-rv>. B<False>: regular screen colours [default]; option	658	option B<-rv>. B<False>: regular screen colours [default]; option
444	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	659	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
445		660
446	=item B<jumpScroll:> I<boolean>	661	=item B<jumpScroll:> I<boolean>
447		662
448	B<True>: specify that jump scrolling should be used. When scrolling	663	B<True>: specify that jump scrolling should be used. When receiving lots
449	quickly, fewer screen updates are performed [default]; option B<-j>.	664	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		665	has been read, resulting in fewer updates while still displaying every
		666	received line; option B<-j>.
		667
450	B<False>: specify that smooth scrolling should be used; option B<+j>.	668	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		669	force a screen refresh on each new line it received; option B<+j>.
451		670
452	=item B<inheritPixmap:> I<boolean>	671	=item B<skipScroll:> I<boolean>
453		672
454	B<True>: make the background inherit the parent windows' pixmap, giving	673	B<True>: (the default) specify that skip scrolling should be used. When
455	artificial transparency. B<False>: do not inherit the parent windows'	674	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
456	pixmap.	675	(around 60 times per second), resulting in far fewer updates. This can
		676	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		677	option B<-ss>.
		678
		679	B<False>: specify that everything is to be displayed, even
		680	if the refresh is too fast for the human eye to read anything (or the
		681	monitor to display anything); option B<+ss>.
		682
		683	=item B<transparent:> I<boolean>
		684
		685	Turn on/off illusion of a transparent window background.
		686
		687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		688	future versions.
		689
		690	I<Please address all transparency related issues to Sasha Vasko at
		691	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
457		692
458	=item B<fading:> I<number>	693	=item B<fading:> I<number>
459		694
460	Fade the text by the given percentage when focus is lost.	695	Fade the text by the given percentage when focus is lost; option B<-fade>.
		696
		697	=item B<fadeColor:> I<colour>
		698
		699	Fade to this colour, when fading is used (see B<fading:>). The default
		700	colour is black; option B<-fadecolor>.
461		701
462	=item B<tintColor:> I<colour>	702	=item B<tintColor:> I<colour>
463		703
464	Tint the transparent background pixmap with the given colour.	704	Tint the transparent background pixmap with the given colour; option
		705	B<-tint>.
465		706
466	=item B<shading:> I<number>	707	=item B<shading:> I<number>
467		708
468	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	709	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
469	image in addition to tinting it.	710	in addition to tinting it; option B<-sh>.
		711
		712	=item B<blendType:> I<string>
		713
		714	Specify background blending type; option B<-blt>.
		715
		716	=item B<blurRadius:> I<number>
		717
		718	Apply Gaussian Blurr with the specified radius to the transparent
		719	background image; option B<-blr>.
470		720
471	=item B<scrollColor:> I<colour>	721	=item B<scrollColor:> I<colour>
472		722
473	Use the specified colour for the scrollbar [default #B2B2B2].	723	Use the specified colour for the scrollbar [default #B2B2B2].
474		724
475	=item B<troughColor:> I<colour>	725	=item B<troughColor:> I<colour>
476		726
477	Use the specified colour for the scrollbar's trough area [default	727	Use the specified colour for the scrollbar's trough area [default
478	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	728	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
479		729
480	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
481		731
482	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
483	and the text.	733	and the text.
484		734
485	=item B<backgroundPixmap:> I<file[;geom]>	735	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
486		736
487	Use the specified XPM file (note the `.xpm' extension is optional) for	737	Use the specified image file for the background and also
488	the background and also optionally specify its scaling with a geometry	738	optionally specify its scaling with a geometry string B<WxH+X+Y>,
489	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	739	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
490	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	740	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
491	centre (percent). A scale of 0 displays the image with tiling. A scale	741	centre (percent). A scale of 0 displays the image with tiling. A scale
492	of 1 displays the image without any scaling. A scale of 2 to 9	742	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
493	specifies an integer number of images in that direction. No image will	743	an integer number of images in that direction. No image will be magnified
494	be magnified beyond 10 times its original size. The maximum permitted	744	beyond 10 times its original size. The maximum permitted scale is 1000.
495	scale is 1000. [default 0x0+50+50]	745	Additional operations can be specified after colon B<:op1:op2...>.
		746	Supported operations are:
496		747
497	=item B<menu:> I<file[;tag]>	748	tile force background image to be tiled and not scaled. Equivalent to 0x0
		749	propscale will scale image keeping proportions
		750	auto will scale image to match window size. Equivalent to 100x100
		751	hscale will scale image horizontally to the window size
		752	vscale will scale image vertically to the window size
		753	scale will scale image to match window size
		754	root will tile image as if it was a root window background, auto-adjusting
		755	whenever terminal window moves
498		756
499	Read in the specified menu file (note the `.menu' extension is	757	If used in conjunction with B<-tr> option, the specified pixmap will be
500	optional) and also optionally specify a starting tag to find. See the	758	blended over transparency image using either alpha-blending, or any
501	reference documentation for details on the syntax for the menuBar.	759	other blending type, specified with B<-blt "type"> option.
502		760
503	=item B<path:> I<path>	761	=item B<path:> I<path>
504		762
505	Specify the colon-delimited search path for finding files (XPM and	763	Specify the colon-delimited search path for finding background image files.
506	menus), in addition to the paths specified by the B<RXVTPATH> and
507	B<PATH> environment variables.
508		764
509	=item B<font:> I<fontlist>	765	=item B<font:> I<fontlist>
510		766
511	Select the fonts to be used. This is a comma separated list of font	767	Select the fonts to be used. This is a comma separated list of font names
512	names that are used in turn when trying to display Unicode characters.	768	that are checked in order when trying to find glyphs for characters. The
513	The first font defines the cell size for characters; other fonts might	769	first font defines the cell size for characters; other fonts might be
514	be smaller, but not larger. A reasonable default font list is always	770	smaller, but not (in general) larger. A (hopefully) reasonable default
515	appended to it. option B<-fn>.	771	font list is always appended to it; option B<-fn>.
516		772
517	Each font can either be a standard X11 core font (XLFD) name, with	773	Each font can either be a standard X11 core font (XLFD) name, with
518	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.	774	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
519		775
520	In addition, each font can be prefixed with additional hints and	776	In addition, each font can be prefixed with additional hints and
521	specifications enclosed in square brackets (C<[]>). The only available	777	specifications enclosed in square brackets (C<[]>). The only available
522	hint currently is C<codeset=codeset-name>, and this is only used for Xft	778	hint currently is C<codeset=codeset-name>, and this is only used for Xft
523	fonts.	779	fonts.
524		780
525	For example, this font resource	781	For example, this font resource
526		782
527	URxvt*font: 9x15bold,\	783	URxvt.font: 9x15bold,\
528	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	784	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
529	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	785	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
530	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	786	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
531	xft:Code2000:antialias=false	787	xft:Code2000:antialias=false
532		788
533	specifies five fonts to be used. The first one is C<9x15bold> (actually	789	specifies five fonts to be used. The first one is C<9x15bold> (actually
534	the iso8859-1 version of the second font), which is the base font (because	790	the iso8859-1 version of the second font), which is the base font (because
535	it is named first) and thus defines the character cell grid to be 9 pixels	791	it is named first) and thus defines the character cell grid to be 9 pixels
536	wide and 15 pixels high.	792	wide and 15 pixels high.
537		793
538	the second font is just used to add additional unicode characters not in	794	The second font is just used to add additional unicode characters not in
539	the base font, likewise the third, which is unfortunately non-bold, but	795	the base font, likewise the third, which is unfortunately non-bold, but
540	the bold version of the font does contain less characters, so this is a	796	the bold version of the font does contain less characters, so this is a
541	useful supplement.	797	useful supplement.
542		798
543	The third font is an Xft font with aliasing turned off, and the characters	799	The third font is an Xft font with aliasing turned off, and the characters
…		…
566	not possible, replacement fonts of the desired shape will be tried.	822	not possible, replacement fonts of the desired shape will be tried.
567		823
568	If set, but empty, then this specific style is disabled and the normal	824	If set, but empty, then this specific style is disabled and the normal
569	text font will being used for the given style.	825	text font will being used for the given style.
570		826
571	=item B<selectstyle:> I<mode>	827	=item B<intensityStyles:> I<boolean>
572		828
573	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	829	When font styles are not enabled, or this option is enabled (B<True>,
574	xterm style with 2.20 old word selection, or anything else which gives	830	option B<-is>, the default), bold/blink font styles imply high
575	xterm style selection.	831	intensity foreground/background colours. Disabling this option (B<False>,
576		832	option B<+is>) disables this behaviour, the high intensity colours are not
577	=item B<scrollstyle:> I<mode>	833	reachable.
578
579	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
580	the author's favourite..
581		834
582	=item B<title:> I<string>	835	=item B<title:> I<string>
583		836
584	Set window title string, the default title is the command-line	837	Set window title string, the default title is the command-line
585	specified after the B<-e> option, if any, otherwise the application	838	specified after the B<-e> option, if any, otherwise the application
…		…
594	=item B<mapAlert:> I<boolean>	847	=item B<mapAlert:> I<boolean>
595		848
596	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	849	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
597	de-iconify (map) on receipt of a bell character [default].	850	de-iconify (map) on receipt of a bell character [default].
598		851
		852	=item B<urgentOnBell:> I<boolean>
		853
		854	B<True>: set the urgency hint for the wm on receipt of a bell character.
		855	B<False>: do not set the urgency hint [default].
		856
599	=item B<visualBell:> I<boolean>	857	=item B<visualBell:> I<boolean>
600		858
601	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	859	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
602	B<False>: no visual bell [default]; option B<+vb>.	860	B<False>: no visual bell [default]; option B<+vb>.
603		861
…		…
617		875
618	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	876	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
619	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	877	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
620	B<Shift-Print> to include the scrollback as well.	878	B<Shift-Print> to include the scrollback as well.
621		879
		880	The string will be interpreted as if typed into the shell as-is.
		881
		882	Example:
		883
		884	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		885
		886	This creates a new file in your home directory with the screen contents
		887	every time you hit C<Print>.
		888
		889	=item B<scrollstyle:> I<mode>
		890
		891	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		892	the author's favourite.
		893
622	=item B<scrollBar:> I<boolean>	894	=item B<scrollBar:> I<boolean>
623		895
624	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	896	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
625	disable the scrollbar; option B<+sb>.	897	disable the scrollbar; option B<+sb>.
626		898
…		…
646	B<+si>.	918	B<+si>.
647		919
648	=item B<scrollWithBuffer:> I<boolean>	920	=item B<scrollWithBuffer:> I<boolean>
649		921
650	B<True>: scroll with scrollback buffer when tty receives new lines (and	922	B<True>: scroll with scrollback buffer when tty receives new lines (and
651	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	923	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
652	with scrollback buffer when tty recieves new lines; option B<-sw>.	924	with scrollback buffer when tty receives new lines; option B<+sw>.
653		925
654	=item B<scrollTtyKeypress:> I<boolean>	926	=item B<scrollTtyKeypress:> I<boolean>
655		927
656	B<True>: scroll to bottom when a non-special key is pressed. Special keys	928	B<True>: scroll to bottom when a non-special key is pressed. Special keys
657	are those which are intercepted by rxvt-unicode for special handling and	929	are those which are intercepted by rxvt-unicode for special handling and
…		…
676	=item B<borderLess:> I<boolean>	948	=item B<borderLess:> I<boolean>
677		949
678	Set MWM hints to request a borderless window, i.e. if honoured by the	950	Set MWM hints to request a borderless window, i.e. if honoured by the
679	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	951	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
680		952
		953	=item B<skipBuiltinGlyphs:> I<boolean>
		954
		955	Compile I<frills>: Disable the usage of the built-in block graphics/line
		956	drawing characters and just rely on what the specified fonts provide. Use
		957	this if you have a good font and want to use its block graphic glyphs;
		958	option B<-sbg>.
		959
681	=item B<termName:> I<termname>	960	=item B<termName:> I<termname>
682		961
683	Specifies the terminal type name to be set in the B<TERM> environment	962	Specifies the terminal type name to be set in the B<TERM> environment
684	variable; option B<-tn>.	963	variable; option B<-tn>.
685		964
686	=item B<linespace:> I<number>	965	=item B<lineSpace:> I<number>
687		966
688	Specifies number of lines (pixel height) to insert between each row of	967	Specifies number of lines (pixel height) to insert between each row of
689	the display [default 0]; option B<-lsp>.	968	the display [default 0]; option B<-lsp>.
690		969
691	=item B<meta8:> I<boolean>	970	=item B<meta8:> I<boolean>
…		…
695		974
696	=item B<mouseWheelScrollPage:> I<boolean>	975	=item B<mouseWheelScrollPage:> I<boolean>
697		976
698	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	977	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699	scrolls five lines [default].	978	scrolls five lines [default].
		979
		980	=item B<pastableTabs:> I<boolean>
		981
		982	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		983	movement only; option C<-ptab>.
700		984
701	=item B<cursorBlink:> I<boolean>	985	=item B<cursorBlink:> I<boolean>
702		986
703	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	987	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
704	option B<-bc>.	988	option B<-bc>.
…		…
717		1001
718	Mouse pointer background colour.	1002	Mouse pointer background colour.
719		1003
720	=item B<pointerBlankDelay:> I<number>	1004	=item B<pointerBlankDelay:> I<number>
721		1005
722	Specifies number of seconds before blanking the pointer [default 2].	1006	Specifies number of seconds before blanking the pointer [default 2]. Use a
		1007	large number (e.g. C<987654321>) to effectively disable the timeout.
723		1008
724	=item B<backspacekey:> I<string>	1009	=item B<backspacekey:> I<string>
725		1010
726	The string to send when the backspace key is pressed. If set to B<DEC>	1011	The string to send when the backspace key is pressed. If set to B<DEC>
727	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1012	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
734	pressed. If unset it will send the sequence traditionally associated	1019	pressed. If unset it will send the sequence traditionally associated
735	with the B<Execute> key.	1020	with the B<Execute> key.
736		1021
737	=item B<cutchars:> I<string>	1022	=item B<cutchars:> I<string>
738		1023
739	The characters used as delimiters for double-click word selection. The	1024	The characters used as delimiters for double-click word selection
740	built-in default:	1025	(whitespace delimiting is added automatically if resource is given).
741		1026
		1027	When the perl selection extension is in use (the default if compiled
		1028	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1029	characters will be created (if the resource exists, otherwise, no regex
		1030	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1031
		1032	When the selection extension is not used, only ISO-8859-1 characters can
		1033	be used. If not specified, the built-in default is used:
		1034
742	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1035	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
743		1036
744	=item B<preeditType:> I<style>	1037	=item B<preeditType:> I<style>
745		1038
746	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1039	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
747		1040
…		…
749		1042
750	I<name> of inputMethod to use; option B<-im>.	1043	I<name> of inputMethod to use; option B<-im>.
751		1044
752	=item B<imLocale:> I<name>	1045	=item B<imLocale:> I<name>
753		1046
754	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	1047	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
755	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	1048	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
756	extension to be able to input japanese characters while staying in	1049	input extension to be able to input japanese characters while staying in
757	another locale. option B<-imlocale>.	1050	another locale; option B<-imlocale>.
		1051
		1052	=item B<imFont:> I<fontset>
		1053
		1054	Specify the font-set used for XIM styles C<OverTheSpot> or
		1055	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		1056	by commas), i.e. it's not in the same format as the other font lists used
		1057	in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
		1058	found, preferably one or two pixels differing in size to the base font.
		1059	option B<-imfont>.
		1060
		1061	=item B<tripleclickwords:> I<boolean>
		1062
		1063	Change the meaning of triple-click selection with the left mouse
		1064	button. Instead of selecting a full line it will extend the selection to
		1065	the end of the logical line only; option B<-tcw>.
758		1066
759	=item B<insecure:> I<boolean>	1067	=item B<insecure:> I<boolean>
760		1068
761	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1069	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762	echo arbitrary strings like the icon name or the locale. This could be	1070	echo arbitrary strings like the icon name or the locale. This could be
763	abused if somebody gets 8-bit-clean access to your display, whether	1071	abused if somebody gets 8-bit-clean access to your display, whether
764	throuh a mail client displaying mail bodies unfiltered or though	1072	through a mail client displaying mail bodies unfiltered or through
765	write(1). Therefore, these sequences are disabled by default. (Note	1073	write(1) or any other means. Therefore, these sequences are disabled by
766	that other terminals, including xterm, have these sequences	1074	default. (Note that many other terminals, including xterm, have these
767	enabled by default). You can enable them by setting this boolean	1075	sequences enabled by default, which doesn't make it safer, though).
768	resource or specifying B<-insecure> as an option. At the moment, this	1076
769	enabled display-answer, locale, findfont, icon label and window title	1077	You can enable them by setting this boolean resource or specifying
770	requests as well as dynamic menubar dispatch.	1078	B<-insecure> as an option. At the moment, this enables display-answer,
		1079	locale, findfont, icon label and window title requests.
771		1080
772	=item B<modifier:> I<modifier>	1081	=item B<modifier:> I<modifier>
773		1082
774	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1083	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
775	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1084	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
779		1088
780	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1089	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
781	character is passed through. It may contain escape values as described	1090	character is passed through. It may contain escape values as described
782	in the entry on B<keysym> following.	1091	in the entry on B<keysym> following.
783		1092
784	=item B<secondaryScreen:> I<bool>	1093	=item B<secondaryScreen:> I<boolean>
785		1094
786	Turn on/off secondary screen (default enabled).	1095	Turn on/off secondary screen (default enabled).
787		1096
788	=item B<secondaryScroll:> I<bool>	1097	=item B<secondaryScroll:> I<boolean>
789		1098
790	Turn on/off secondary screen scroll (default enabled). If the this	1099	Turn on/off secondary screen scroll (default enabled). If this
791	option is enabled, scrolls on the secondary screen will change the	1100	option is enabled, scrolls on the secondary screen will change the
792	scrollback buffer and switching to/from the secondary screen will	1101	scrollback buffer and, when secondaryScreen is off, switching
793	instead scroll the screen up.	1102	to/from the secondary screen will instead scroll the screen up.
		1103
		1104	=item B<hold>: I<boolean>
		1105
		1106	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1107	will not immediately destroy its window when the program executed within
		1108	it exits. Instead, it will wait till it is being killed or closed by the
		1109	user.
		1110
		1111	=item B<chdir>: I<path>
		1112
		1113	Sets the working directory for the shell (or the command specified via
		1114	B<-e>). The I<path> must be an absolute path and it must exist for
		1115	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1116	directory will be used; option B<-cd>.
794		1117
795	=item B<keysym.>I<sym>: I<string>	1118	=item B<keysym.>I<sym>: I<string>
796		1119
797	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1120	Compile I<frills>: Associate I<string> with keysym I<sym>. The
798	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
799	newline, \r: return, \t:
800	tab, \000: octal number) or control characters (^?: delete, ^@: null,
801	^A ...) and may enclosed with double quotes so that it can start or end
802	with whitespace. The intervening resource name B<keysym.> cannot be	1121	intervening resource name B<keysym.> cannot be omitted.
803	omitted. This resource is only available when compiled with	1122
804	KEYSYM_RESOURCE.	1123	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		1124	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		1125	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1126	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1127	B<2>, B<3>, B<4>, B<5>.
		1128
		1129	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1130	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1131	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1132	current application keymap mode state.
		1133
		1134	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1135	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1136	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1137	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1138	performed in an exact manner; however, the closest match is assured.
		1139
		1140	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
		1141	number), see RESOURCES in C<man 7 X> for futher details.
		1142
		1143	You can define a range of keysyms in one shot by providing a I<string>
		1144	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
		1145	should be a character not used by the strings.
		1146
		1147	Its usage can be demonstrated by an example:
		1148
		1149	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
		1150
		1151	The above line is equivalent to the following three lines:
		1152
		1153	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1154	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1155	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1156
		1157	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1158	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1159	example the following means "change the current locale to C<zh_CN.GBK>
		1160	when Control-Meta-c is being pressed":
		1161
		1162	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1163
		1164	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1165	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1166	manpage. For example, the F<selection> extension (activated via
		1167	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1168
		1169	URxvt.keysym.M-C-c: perl:selection:rot13
		1170
		1171	Due the the large number of modifier combinations, a defined key mapping
		1172	will match if at I<at least> the specified identifiers are being set, and
		1173	no other key mappings with those and more bits are being defined. That
		1174	means that defining a key map for C<a> will automatically provide
		1175	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1176	mappings themselves.
		1177
		1178	Unfortunately, this will override built-in key mappings. For example
		1179	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1180	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1181	user-defined keymap using the C<builtin:> replacement:
		1182
		1183	URxvt.keysym.Insert: <my insert key sequence>
		1184	URxvt.keysym.S-Insert: builtin:
		1185
		1186	The first line defines a mapping for C<Insert> and I<any> combination
		1187	of modifiers. The second line re-establishes the default mapping for
		1188	C<Shift-Insert>.
		1189
		1190	The following example will map Control-Meta-1 and Control-Meta-2 to
		1191	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1192	font-switching at runtime:
		1193
		1194	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1195	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1196
		1197	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1198	info):
		1199
		1200	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1201	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1202
		1203	=item B<perl-ext-common>: I<string>
		1204
		1205	=item B<perl-ext>: I<string>
		1206
		1207	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1208	use in this terminal instance; option B<-pe>.
		1209
		1210	Extension names can be prefixed with a C<-> sign to prohibit using
		1211	them. This can be useful to selectively disable some extensions loaded
		1212	by default, or specified via the C<perl-ext-common> resource. For
		1213	example, C<default,-selection> will use all the default extension except
		1214	C<selection>.
		1215
		1216	Extension names can also be followed by an argument in angle brackets
		1217	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1218	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1219	multiple times with different arguments will pass multiple arguments to
		1220	the extension.
		1221
		1222	Each extension is looked up in the library directories, loaded if
		1223	necessary, and bound to the current terminal instance.
		1224
		1225	If both of these resources are the empty string, then the perl
		1226	interpreter will not be initialized. The idea behind two options is that
		1227	B<perl-ext-common> will be used for extensions that should be available to
		1228	all instances, while B<perl-ext> is used for specific instances.
		1229
		1230	=item B<perl-eval>: I<string>
		1231
		1232	Perl code to be evaluated when all extensions have been registered. See
		1233	the @@RXVT_NAME@@perl(3) manpage.
		1234
		1235	=item B<perl-lib>: I<path>
		1236
		1237	Colon-separated list of additional directories that hold extension
		1238	scripts. When looking for extensions specified by the C<perl> resource,
		1239	@@RXVT_NAME@@ will first look in these directories and then in
		1240	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1241
		1242	See the @@RXVT_NAME@@perl(3) manpage.
		1243
		1244	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1245
		1246	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1247	details.
		1248
		1249	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1250
		1251	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1252	for details.
		1253
		1254	=item B<searchable-scrollback:> I<keysym>
		1255
		1256	Sets the hotkey that starts the incremental scrollback buffer search
		1257	(default: C<M-s>).
		1258
		1259	=item B<urlLauncher>: I<string>
		1260
		1261	Specifies the program to be started with a URL argument. Used by the
		1262	C<selection-popup> and C<matcher> perl extensions.
		1263
		1264	=item B<transient-for>: I<windowid>
		1265
		1266	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1267
		1268	=item B<override-redirect>: I<boolean>
		1269
		1270	Compile I<frills>: Sets override-redirect for the terminal window, making
		1271	it almost invisible to window managers; option B<-override-redirect>.
		1272
		1273	=item B<iso14755_52:> I<boolean>
		1274
		1275	Turn on/off ISO 14755 5.2 mode (default enabled).
805		1276
806	=back	1277	=back
807		1278
808	=head1 THE SCROLLBAR	1279	=head1 THE SCROLLBAR
809		1280
…		…
823	the normal text selection/insertion, hold either the Shift or the Meta	1294	the normal text selection/insertion, hold either the Shift or the Meta
824	(Alt) key while performing the desired mouse action.	1295	(Alt) key while performing the desired mouse action.
825		1296
826	If mouse reporting mode is active, the normal scrollbar actions are	1297	If mouse reporting mode is active, the normal scrollbar actions are
827	disabled -- on the assumption that we are using a fullscreen	1298	disabled -- on the assumption that we are using a fullscreen
828	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1299	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
829	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1300	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
830	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1301	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
831	respectively.	1302	respectively.
832		1303
833	=head1 TEXT SELECTION AND INSERTION	1304	=head1 THE SELECTION: SELECTING AND PASTING TEXT
834		1305
835	The behaviour of text selection and insertion mechanism is similar to	1306	The behaviour of text selection and insertion/pasting mechanism is similar
836	I<xterm>(1).	1307	to I<xterm>(1).
837		1308
838	=over 4	1309	=over 4
839		1310
840	=item B<Selection>:	1311	=item B<Selecting>:
841		1312
842	Left click at the beginning of the region, drag to the end of the	1313	Left click at the beginning of the region, drag to the end of the region
843	region and release; Right click to extend the marked region; Left	1314	and release; Right click to extend the marked region; Left double-click
844	double-click to select a word; Left triple-click to select the entire	1315	to select a word; Left triple-click to select the entire logical line
845	line.	1316	(which can span multiple screen lines), unless modified by resource
		1317	B<tripleclickwords>.
846		1318
847	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1319	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
848	(Compile: frills) will create a rectangular selection instead of a normal	1320	(Compile: I<frills>) will create a rectangular selection instead of a
849	one.	1321	normal one. In this mode, every selected row becomes its own line in the
		1322	selection, and trailing whitespace is visually underlined and removed from
		1323	the selection.
850		1324
851	=item B<Insertion>:	1325	=item B<Pasting>:
852		1326
853	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1327	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
854	an B<@@RXVT_NAME@@> window causes the current text selection to be	1328	window causes the value of the PRIMARY selection (or CLIPBOARD with the
855	inserted as if it had been typed on the keyboard.	1329	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1330
		1331	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1332	inserted too.
856		1333
857	=back	1334	=back
858		1335
859	=head1 CHANGING FONTS	1336	=head1 CHANGING FONTS
860		1337
861	Changing fonts (or font sizes, respectively) via the keypad is not yet	1338	Changing fonts (or font sizes, respectively) via the keypad is not yet
862	supported in rxvt-unicode. Bug me if you need this.	1339	supported in rxvt-unicode. Bug me if you need this.
863		1340
864	You can, however, switch fonts at runtime using escape sequences (and	1341	You can, however, switch fonts at runtime using escape sequences, e.g.:
865	therefore using the menubar), e.g.:
866		1342
867	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1343	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1344
		1345	You can use keyboard shortcuts, too:
		1346
		1347	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1348	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
868		1349
869	rxvt-unicode will automatically re-apply these fonts to the output so far.	1350	rxvt-unicode will automatically re-apply these fonts to the output so far.
870		1351
871	=head1 ISO 14755 SUPPORT	1352	=head1 ISO 14755 SUPPORT
872		1353
873	ISO 14755 is a standard for entering and viewing unicode characters	1354	ISO 14755 is a standard for entering and viewing unicode characters
874	and character codes using the keyboard. It consists of 4 parts. The	1355	and character codes using the keyboard. It consists of 4 parts. The
875	first part is available rxvt-unicode has been compiled with	1356	first part is available if rxvt-unicode has been compiled with
876	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1357	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
877	with C<--enable-iso14755>.	1358	with C<--enable-iso14755>.
878		1359
879	=over 4	1360	=over 4
880		1361
881	=item 5.1: Basic method	1362	=item * 5.1: Basic method
882		1363
883	This allows you to enter unicode characters using their hexcode.	1364	This allows you to enter unicode characters using their hexcode.
884		1365
885	Start by pressing and holding both C<Control> and C<Shift>, then enter	1366	Start by pressing and holding both C<Control> and C<Shift>, then enter
886	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1367	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
893	address, which you cannot type. Fortunately, the card has the e-mail	1374	address, which you cannot type. Fortunately, the card has the e-mail
894	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1375	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
895	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1376	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
896	followed by releasing the modifier keys.	1377	followed by releasing the modifier keys.
897		1378
898	=item 5.2: Keyboard symbols entry method	1379	=item * 5.2: Keyboard symbols entry method
899		1380
900	This mode lets you input characters representing the keycap symbols of	1381	This mode lets you input characters representing the keycap symbols of
901	your keyboard, if representable in the current locale encoding.	1382	your keyboard, if representable in the current locale encoding.
902		1383
903	Start by pressing C<Control> and C<Shift> together, then releasing	1384	Start by pressing C<Control> and C<Shift> together, then releasing
904	them. The next special key (cursor keys, home etc.) you enter will not	1385	them. The next special key (cursor keys, home etc.) you enter will not
905	invoke it's usual function but instead will insert the corresponding	1386	invoke its usual function but instead will insert the corresponding
906	keycap symbol. The symbol will only be entered when the key has been	1387	keycap symbol. The symbol will only be entered when the key has been
907	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1388	released, otherwise pressing e.g. C<Shift> would enter the symbol for
908	C<ISO Level 2 Switch>, although your intention might have been to enter a	1389	C<ISO Level 2 Switch>, although your intention might have been to enter a
909	reverse tab (Shift-Tab).	1390	reverse tab (Shift-Tab).
910		1391
911	=item 5.3: Screen-selection entry method	1392	=item * 5.3: Screen-selection entry method
912		1393
913	While this is implemented already (it's basically the selection	1394	While this is implemented already (it's basically the selection
914	mechanism), it could be extended by displaying a unicode character map.	1395	mechanism), it could be extended by displaying a unicode character map.
915		1396
916	=item 5.4: Feedback method for identifying displayed characters for later input	1397	=item * 5.4: Feedback method for identifying displayed characters for later input
917		1398
918	This method lets you display the unicode character code associated with	1399	This method lets you display the unicode character code associated with
919	characters already displayed.	1400	characters already displayed.
920		1401
921	You enter this mode by holding down C<Control> and C<Shift> together, then	1402	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
933	With respect to conformance, rxvt-unicode is supposed to be compliant to	1414	With respect to conformance, rxvt-unicode is supposed to be compliant to
934	both scenario A and B of ISO 14755, including part 5.2.	1415	both scenario A and B of ISO 14755, including part 5.2.
935		1416
936	=head1 LOGIN STAMP	1417	=head1 LOGIN STAMP
937		1418
938	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1419	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
939	that it can be seen via the I<who(1)> command, and can accept messages.	1420	it can be seen via the I<who(1)> command, and can accept messages. To
940	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1421	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
941	some systems.	1422	on some systems or setgid to root or to some other group on others.
942		1423
943	=head1 COLORS AND GRAPHICS	1424	=head1 COLORS AND GRAPHICS
944		1425
945	In addition to the default foreground and background colours,	1426	In addition to the default foreground and background colours,
946	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1427	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
947	high-intensity bold/blink versions of the same). Here is a list of the	1428	high-intensity bold/blink versions of the same). Here is a list of the
948	colours with their B<rgb.txt> names.	1429	colours with their names.
949		1430
950	=begin table	1431	=begin table
951		1432
952	B<color0> (black) = Black	1433	B<color0> (black) = Black
953	B<color1> (red) = Red3	1434	B<color1> (red) = Red3
…		…
973	It is also possible to specify the colour values of B<foreground>,	1454	It is also possible to specify the colour values of B<foreground>,
974	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1455	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
975	a number 0-15, as a convenient shorthand to reference the colour name of	1456	a number 0-15, as a convenient shorthand to reference the colour name of
976	color0-color15.	1457	color0-color15.
977		1458
		1459	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1460	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1461	consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1462	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1463
		1464	Together, all those colours implement the 88 colour xterm colours. Only
		1465	the first 16 can be changed using resources currently, the rest can only
		1466	be changed via command sequences ("escape codes").
		1467
978	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1468	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
979	always swapping the foreground/background colours. This is in contrast to	1469	always swapping the foreground/background colours. This is in contrast to
980	I<xterm>(1) where the colours are only swapped if they have not otherwise	1470	I<xterm>(1) where the colours are only swapped if they have not otherwise
981	been specified. For example,	1471	been specified. For example,
982		1472
…		…
987	would yield White on Black, while on I<xterm>(1) it would yield Black	1477	would yield White on Black, while on I<xterm>(1) it would yield Black
988	on White.	1478	on White.
989		1479
990	=back	1480	=back
991		1481
		1482	=head2 ALPHA CHANNEL SUPPORT
		1483
		1484	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1485	their act together, rxvt-unicode will do it's own alpha channel management:
		1486
		1487	You can prefix any color with an opaquenes percentage enclosed in
		1488	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1489	(0-100) that specifies the opacity of the color, where C<0> is completely
		1490	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1491	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1492	is the recommended format to specify transparency values, and works with
		1493	all ways to specify a colour.
		1494
		1495	For complete control, rxvt-unicode also supports
		1496	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1497	specifications, where the additional C<aaaa> component specifies opacity
		1498	(alpha) values. The minimum value of C<0000> is completely transparent,
		1499	while C<ffff> is completely opaque). The two example colours from
		1500	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1501	C<rgba:0000/ff00/0000/f332>.
		1502
		1503	You probably need to specify B<"-depth 32">, too, to force a visual with
		1504	alpha channels, and have the luck that your X-server uses ARGB pixel
		1505	layout, as X is far from just supporting ARGB visuals out of the box, and
		1506	rxvt-unicode just fudges around.
		1507
		1508	For example, the following selects an almost completely transparent black
		1509	background, and an almost opaque pink foreground:
		1510
		1511	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1512
		1513	When not using a background image, then the interpretation of the
		1514	alpha channel is up to your compositing manager (most interpret it as
		1515	transparency of course).
		1516
		1517	When using a background pixmap or pseudo-transparency, then the background
		1518	colour will always behave as if it were completely transparent (so the
		1519	background image shows instead), regardless of how it was specified, while
		1520	other colours will either be transparent as specified (the background
		1521	image will show through) on servers supporting the RENDER extension, or
		1522	fully opaque on servers not supporting the RENDER EXTENSION.
		1523
		1524	Please note that due to bugs in Xft, specifying alpha values might result
		1525	in garbage being displayed when the X-server does not support the RENDER
		1526	extension.
		1527
992	=head1 ENVIRONMENT	1528	=head1 ENVIRONMENT
993		1529
994	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1530	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
995	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1531
996	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1532	=over 4
997	sets the environment variable B<DISPLAY> to specify which display	1533
998	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1534	=item B<TERM>
999	B<RXVTPATH> and B<PATH> to find XPM files.	1535
		1536	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1537	resources or on the command line.
		1538
		1539	=item B<COLORTERM>
		1540
		1541	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1542	compiled with background image support, and optionally with the added
		1543	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1544	screen.
		1545
		1546	=item B<COLORFGBG>
		1547
		1548	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1549	the colour code used as default foreground/text colour (or the string
		1550	C<default> to indicate that the default-colour escape sequence is to be
		1551	used), C<bg> is the colour code used as default background colour (or the
		1552	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1553	was compiled with background image support. Libraries like C<ncurses>
		1554	and C<slang> can (and do) use this information to optimize screen output.
		1555
		1556	=item B<WINDOWID>
		1557
		1558	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1559	window, which usually has subwindows for the scrollbar, the terminal
		1560	window and so on).
		1561
		1562	=item B<TERMINFO>
		1563
		1564	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1565	C<--with-terminfo=PATH>.
		1566
		1567	=item B<DISPLAY>
		1568
		1569	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1570	display in its child processes if C<-display> isn't used to override. It
		1571	defaults to C<:0> if it doesn't exist.
		1572
		1573	=item B<SHELL>
		1574
		1575	The shell to be used for command execution, defaults to C</bin/sh>.
		1576
		1577	=item B<RXVT_SOCKET>
		1578
		1579	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1580	@@RXVT_NAME@@d(1).
		1581
		1582	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1583
		1584	=item B<HOME>
		1585
		1586	Used to locate the default directory for the unix domain socket for
		1587	daemon communications and to locate various resource files (such as
		1588	C<.Xdefaults>)
		1589
		1590	=item B<XAPPLRESDIR>
		1591
		1592	Directory where various X resource files are being located.
		1593
		1594	=item B<XENVIRONMENT>
		1595
		1596	If set and accessible, gives the name of a X resource file to be loaded by
		1597	@@RXVT_NAME@@.
		1598
		1599	=back
1000		1600
1001	=head1 FILES	1601	=head1 FILES
1002		1602
1003	=over 4	1603	=over 4
1004		1604
1005	=item B</etc/utmp>
1006
1007	System file for login records.
1008
1009	=item B</usr/lib/X11/rgb.txt>	1605	=item B</usr/lib/X11/rgb.txt>
1010		1606
1011	Color names.	1607	Color names.
1012		1608
1013	=back	1609	=back
1014		1610
1015	=head1 SEE ALSO	1611	=head1 SEE ALSO
1016		1612
1017	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1613	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1018
1019	=head1 BUGS
1020
1021	Check the BUGS file for an up-to-date list.
1022
1023	Cursor change support is not yet implemented.
1024
1025	Click-and-drag doesn't work with X11 mouse report overriding.
1026		1614
1027	=head1 CURRENT PROJECT COORDINATOR	1615	=head1 CURRENT PROJECT COORDINATOR
1028		1616
1029	=over 4	1617	=over 4
1030		1618
1031	=item Project Coordinator	1619	=item Project Coordinator
1032		1620
1033	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1621	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1034		1622
1035	=item Web page maintainter	1623	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1036
1037	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1038
1039	L<@@RXVT_WEBPAGE@@>
1040		1624
1041	=back	1625	=back
1042		1626
1043	=head1 AUTHORS	1627	=head1 AUTHORS
1044		1628
…		…
1066		1650
1067	Project Coordinator (changes.txt 2.21a to 2.4.5)	1651	Project Coordinator (changes.txt 2.21a to 2.4.5)
1068		1652
1069	=item Geoff Wing L<< <gcw@pobox.com> >>	1653	=item Geoff Wing L<< <gcw@pobox.com> >>
1070		1654
1071	Rewrote screen display and text selection routines. Project Coordinator	1655	Rewrote screen display and text selection routines.
		1656
1072	(changes.txt 2.4.6 - rxvt-unicode)	1657	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1073		1658
1074	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1659	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1075		1660
1076	Forked rxvt-unicode, rewrote most of the display code and internal	1661	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1077	character handling to store text in unicode, improve xterm	1662	extension, random hacks, numerous bugfixes and extensions.
1078	compatibility and apply numerous other bugfixes and extensions.
1079		1663
1080	Project Coordinator (Changes 1.0 -)	1664	Project Coordinator (Changes 1.0 -)
1081		1665
		1666	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1667
		1668	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1669
1082	=back	1670	=back
1083		1671

Diff Legend

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