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.30 by root, Wed Sep 8 17:10:23 2004 UTC vs.
Revision 1.167 by root, Wed Oct 15 14:48:22 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>.
470		711
		712	=item B<blendType:> I<string>
		713
		714	Specify background blending type; option B<-blt>.
		715
471	=item B<fading:> I<number>	716	=item B<blurRadius:> I<number>
472		717
473	Scale the tint colour by the given percentage.	718	Apply Gaussian Blurr with the specified radius to the transparent
		719	background image; option B<-blr>.
474		720
475	=item B<scrollColor:> I<colour>	721	=item B<scrollColor:> I<colour>
476		722
477	Use the specified colour for the scrollbar [default #B2B2B2].	723	Use the specified colour for the scrollbar [default #B2B2B2].
478		724
479	=item B<troughColor:> I<colour>	725	=item B<troughColor:> I<colour>
480		726
481	Use the specified colour for the scrollbar's trough area [default	727	Use the specified colour for the scrollbar's trough area [default
482	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	728	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
483		729
484	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
485		731
486	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
487	and the text.	733	and the text.
488		734
489	=item B<backgroundPixmap:> I<file[;geom]>	735	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
490		736
491	Use the specified XPM file (note the `.xpm' extension is optional) for	737	Use the specified image file for the background and also
492	the background and also optionally specify its scaling with a geometry	738	optionally specify its scaling with a geometry string B<WxH+X+Y>,
493	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
494	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	740	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
495	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
496	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
497	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
498	be magnified beyond 10 times its original size. The maximum permitted	744	beyond 10 times its original size. The maximum permitted scale is 1000.
499	scale is 1000. [default 0x0+50+50]	745	Additional operations can be specified after colon B<:op1:op2...>.
		746	Supported operations are:
500		747
501	=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
502		756
503	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
504	optional) and also optionally specify a starting tag to find. See the	758	blended over transparency image using either alpha-blending, or any
505	reference documentation for details on the syntax for the menuBar.	759	other blending type, specified with B<-blt "type"> option.
506		760
507	=item B<path:> I<path>	761	=item B<path:> I<path>
508		762
509	Specify the colon-delimited search path for finding files (XPM and	763	Specify the colon-delimited search path for finding background image files.
510	menus), in addition to the paths specified by the B<RXVTPATH> and
511	B<PATH> environment variables.
512		764
513	=item B<font:> I<fontlist>	765	=item B<font:> I<fontlist>
514		766
515	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
516	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
517	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
518	be smaller, but not larger. A reasonable default font list is always	770	smaller, but not (in general) larger. A (hopefully) reasonable default
519	appended to it. option B<-fn>.	771	font list is always appended to it; option B<-fn>.
520		772
521	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
522	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:>.
523		775
524	In addition, each font can be prefixed with additional hints and	776	In addition, each font can be prefixed with additional hints and
525	specifications enclosed in square brackets (C<[]>). The only available	777	specifications enclosed in square brackets (C<[]>). The only available
526	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
527	fonts.	779	fonts.
528		780
529	For example, this font resource	781	For example, this font resource
530		782
531	URxvt*font: 9x15bold,\	783	URxvt.font: 9x15bold,\
532	-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,\
533	-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, \
534	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	786	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
535	xft:Code2000:antialias=false	787	xft:Code2000:antialias=false
536		788
537	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
538	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
539	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
540	wide and 15 pixels high.	792	wide and 15 pixels high.
541		793
542	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
543	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
544	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
545	useful supplement.	797	useful supplement.
546		798
547	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
…		…
570	not possible, replacement fonts of the desired shape will be tried.	822	not possible, replacement fonts of the desired shape will be tried.
571		823
572	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
573	text font will being used for the given style.	825	text font will being used for the given style.
574		826
575	=item B<selectstyle:> I<mode>	827	=item B<intensityStyles:> I<boolean>
576		828
577	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>,
578	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
579	xterm style selection.	831	intensity foreground/background colours. Disabling this option (B<False>,
580		832	option B<+is>) disables this behaviour, the high intensity colours are not
581	=item B<scrollstyle:> I<mode>	833	reachable.
582
583	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
584	the author's favourite..
585		834
586	=item B<title:> I<string>	835	=item B<title:> I<string>
587		836
588	Set window title string, the default title is the command-line	837	Set window title string, the default title is the command-line
589	specified after the B<-e> option, if any, otherwise the application	838	specified after the B<-e> option, if any, otherwise the application
…		…
598	=item B<mapAlert:> I<boolean>	847	=item B<mapAlert:> I<boolean>
599		848
600	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
601	de-iconify (map) on receipt of a bell character [default].	850	de-iconify (map) on receipt of a bell character [default].
602		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
		857	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		858
603	=item B<visualBell:> I<boolean>	859	=item B<visualBell:> I<boolean>
604		860
605	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	861	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
606	B<False>: no visual bell [default]; option B<+vb>.	862	B<False>: no visual bell [default]; option B<+vb>.
607		863
…		…
621		877
622	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	878	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
623	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	879	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
624	B<Shift-Print> to include the scrollback as well.	880	B<Shift-Print> to include the scrollback as well.
625		881
		882	The string will be interpreted as if typed into the shell as-is.
		883
		884	Example:
		885
		886	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		887
		888	This creates a new file in your home directory with the screen contents
		889	every time you hit C<Print>.
		890
		891	=item B<scrollstyle:> I<mode>
		892
		893	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		894	the author's favourite.
		895
626	=item B<scrollBar:> I<boolean>	896	=item B<scrollBar:> I<boolean>
627		897
628	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	898	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
629	disable the scrollbar; option B<+sb>.	899	disable the scrollbar; option B<+sb>.
630		900
…		…
650	B<+si>.	920	B<+si>.
651		921
652	=item B<scrollWithBuffer:> I<boolean>	922	=item B<scrollWithBuffer:> I<boolean>
653		923
654	B<True>: scroll with scrollback buffer when tty receives new lines (and	924	B<True>: scroll with scrollback buffer when tty receives new lines (and
655	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	925	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
656	with scrollback buffer when tty recieves new lines; option B<-sw>.	926	with scrollback buffer when tty receives new lines; option B<+sw>.
657		927
658	=item B<scrollTtyKeypress:> I<boolean>	928	=item B<scrollTtyKeypress:> I<boolean>
659		929
660	B<True>: scroll to bottom when a non-special key is pressed. Special keys	930	B<True>: scroll to bottom when a non-special key is pressed. Special keys
661	are those which are intercepted by rxvt-unicode for special handling and	931	are those which are intercepted by rxvt-unicode for special handling and
…		…
680	=item B<borderLess:> I<boolean>	950	=item B<borderLess:> I<boolean>
681		951
682	Set MWM hints to request a borderless window, i.e. if honoured by the	952	Set MWM hints to request a borderless window, i.e. if honoured by the
683	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	953	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
684		954
		955	=item B<skipBuiltinGlyphs:> I<boolean>
		956
		957	Compile I<frills>: Disable the usage of the built-in block graphics/line
		958	drawing characters and just rely on what the specified fonts provide. Use
		959	this if you have a good font and want to use its block graphic glyphs;
		960	option B<-sbg>.
		961
685	=item B<termName:> I<termname>	962	=item B<termName:> I<termname>
686		963
687	Specifies the terminal type name to be set in the B<TERM> environment	964	Specifies the terminal type name to be set in the B<TERM> environment
688	variable; option B<-tn>.	965	variable; option B<-tn>.
689		966
690	=item B<linespace:> I<number>	967	=item B<lineSpace:> I<number>
691		968
692	Specifies number of lines (pixel height) to insert between each row of	969	Specifies number of lines (pixel height) to insert between each row of
693	the display [default 0]; option B<-lsp>.	970	the display [default 0]; option B<-lsp>.
694		971
695	=item B<meta8:> I<boolean>	972	=item B<meta8:> I<boolean>
…		…
699		976
700	=item B<mouseWheelScrollPage:> I<boolean>	977	=item B<mouseWheelScrollPage:> I<boolean>
701		978
702	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	979	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
703	scrolls five lines [default].	980	scrolls five lines [default].
		981
		982	=item B<pastableTabs:> I<boolean>
		983
		984	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		985	movement only; option C<-ptab>.
704		986
705	=item B<cursorBlink:> I<boolean>	987	=item B<cursorBlink:> I<boolean>
706		988
707	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	989	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
708	option B<-bc>.	990	option B<-bc>.
…		…
721		1003
722	Mouse pointer background colour.	1004	Mouse pointer background colour.
723		1005
724	=item B<pointerBlankDelay:> I<number>	1006	=item B<pointerBlankDelay:> I<number>
725		1007
726	Specifies number of seconds before blanking the pointer [default 2].	1008	Specifies number of seconds before blanking the pointer [default 2]. Use a
		1009	large number (e.g. C<987654321>) to effectively disable the timeout.
727		1010
728	=item B<backspacekey:> I<string>	1011	=item B<backspacekey:> I<string>
729		1012
730	The string to send when the backspace key is pressed. If set to B<DEC>	1013	The string to send when the backspace key is pressed. If set to B<DEC>
731	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1014	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
738	pressed. If unset it will send the sequence traditionally associated	1021	pressed. If unset it will send the sequence traditionally associated
739	with the B<Execute> key.	1022	with the B<Execute> key.
740		1023
741	=item B<cutchars:> I<string>	1024	=item B<cutchars:> I<string>
742		1025
743	The characters used as delimiters for double-click word selection. The	1026	The characters used as delimiters for double-click word selection
744	built-in default:	1027	(whitespace delimiting is added automatically if resource is given).
745		1028
		1029	When the perl selection extension is in use (the default if compiled
		1030	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1031	characters will be created (if the resource exists, otherwise, no regex
		1032	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1033
		1034	When the selection extension is not used, only ISO-8859-1 characters can
		1035	be used. If not specified, the built-in default is used:
		1036
746	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1037	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
747		1038
748	=item B<preeditType:> I<style>	1039	=item B<preeditType:> I<style>
749		1040
750	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1041	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
751		1042
…		…
753		1044
754	I<name> of inputMethod to use; option B<-im>.	1045	I<name> of inputMethod to use; option B<-im>.
755		1046
756	=item B<imLocale:> I<name>	1047	=item B<imLocale:> I<name>
757		1048
758	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	1049	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
759	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	1050	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
760	extension to be able to input japanese characters while staying in	1051	input extension to be able to input japanese characters while staying in
761	another locale. option B<-imlocale>.	1052	another locale; option B<-imlocale>.
		1053
		1054	=item B<imFont:> I<fontset>
		1055
		1056	Specify the font-set used for XIM styles C<OverTheSpot> or
		1057	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		1058	by commas), i.e. it's not in the same format as the other font lists used
		1059	in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
		1060	found, preferably one or two pixels differing in size to the base font.
		1061	option B<-imfont>.
		1062
		1063	=item B<tripleclickwords:> I<boolean>
		1064
		1065	Change the meaning of triple-click selection with the left mouse
		1066	button. Instead of selecting a full line it will extend the selection to
		1067	the end of the logical line only; option B<-tcw>.
762		1068
763	=item B<insecure:> I<boolean>	1069	=item B<insecure:> I<boolean>
764		1070
765	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1071	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
766	echo arbitrary strings like the icon name or the locale. This could be	1072	echo arbitrary strings like the icon name or the locale. This could be
767	abused if somebody gets 8-bit-clean access to your display, whether	1073	abused if somebody gets 8-bit-clean access to your display, whether
768	throuh a mail client displaying mail bodies unfiltered or though	1074	through a mail client displaying mail bodies unfiltered or through
769	write(1). Therefore, these sequences are disabled by default. (Note	1075	write(1) or any other means. Therefore, these sequences are disabled by
770	that other terminals, including xterm, have these sequences	1076	default. (Note that many other terminals, including xterm, have these
771	enabled by default). You can enable them by setting this boolean	1077	sequences enabled by default, which doesn't make it safer, though).
772	resource or specifying B<-insecure> as an option. At the moment, this	1078
773	enabled display-answer, locale, findfont, icon label and window title	1079	You can enable them by setting this boolean resource or specifying
774	requests as well as dynamic menubar dispatch.	1080	B<-insecure> as an option. At the moment, this enables display-answer,
		1081	locale, findfont, icon label and window title requests.
775		1082
776	=item B<modifier:> I<modifier>	1083	=item B<modifier:> I<modifier>
777		1084
778	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1085	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
779	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1086	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
783		1090
784	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1091	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
785	character is passed through. It may contain escape values as described	1092	character is passed through. It may contain escape values as described
786	in the entry on B<keysym> following.	1093	in the entry on B<keysym> following.
787		1094
788	=item B<secondaryScreen:> I<bool>	1095	=item B<secondaryScreen:> I<boolean>
789		1096
790	Turn on/off secondary screen (default enabled).	1097	Turn on/off secondary screen (default enabled).
791		1098
792	=item B<secondaryScroll:> I<bool>	1099	=item B<secondaryScroll:> I<boolean>
793		1100
794	Turn on/off secondary screen scroll (default enabled). If the this	1101	Turn on/off secondary screen scroll (default enabled). If this
795	option is enabled, scrolls on the secondary screen will change the	1102	option is enabled, scrolls on the secondary screen will change the
796	scrollback buffer and switching to/from the secondary screen will	1103	scrollback buffer and, when secondaryScreen is off, switching
797	instead scroll the screen up.	1104	to/from the secondary screen will instead scroll the screen up.
		1105
		1106	=item B<hold>: I<boolean>
		1107
		1108	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1109	will not immediately destroy its window when the program executed within
		1110	it exits. Instead, it will wait till it is being killed or closed by the
		1111	user.
		1112
		1113	=item B<chdir>: I<path>
		1114
		1115	Sets the working directory for the shell (or the command specified via
		1116	B<-e>). The I<path> must be an absolute path and it must exist for
		1117	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1118	directory will be used; option B<-cd>.
798		1119
799	=item B<keysym.>I<sym>: I<string>	1120	=item B<keysym.>I<sym>: I<string>
800		1121
801	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1122	Compile I<frills>: Associate I<string> with keysym I<sym>. The
802	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
803	newline, \r: return, \t:
804	tab, \000: octal number) or control characters (^?: delete, ^@: null,
805	^A ...) and may enclosed with double quotes so that it can start or end
806	with whitespace. The intervening resource name B<keysym.> cannot be	1123	intervening resource name B<keysym.> cannot be omitted.
807	omitted. This resource is only available when compiled with	1124
808	KEYSYM_RESOURCE.	1125	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		1126	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		1127	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1128	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1129	B<2>, B<3>, B<4>, B<5>.
		1130
		1131	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1132	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1133	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1134	current application keymap mode state.
		1135
		1136	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1137	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1138	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1139	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1140	performed in an exact manner; however, the closest match is assured.
		1141
		1142	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
		1143	number), see RESOURCES in C<man 7 X> for futher details.
		1144
		1145	You can define a range of keysyms in one shot by providing a I<string>
		1146	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
		1147	should be a character not used by the strings.
		1148
		1149	Its usage can be demonstrated by an example:
		1150
		1151	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
		1152
		1153	The above line is equivalent to the following three lines:
		1154
		1155	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1156	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1157	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1158
		1159	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1160	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1161	example the following means "change the current locale to C<zh_CN.GBK>
		1162	when Control-Meta-c is being pressed":
		1163
		1164	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1165
		1166	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1167	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1168	manpage. For example, the F<selection> extension (activated via
		1169	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1170
		1171	URxvt.keysym.M-C-c: perl:selection:rot13
		1172
		1173	Due the the large number of modifier combinations, a defined key mapping
		1174	will match if at I<at least> the specified identifiers are being set, and
		1175	no other key mappings with those and more bits are being defined. That
		1176	means that defining a key map for C<a> will automatically provide
		1177	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1178	mappings themselves.
		1179
		1180	Unfortunately, this will override built-in key mappings. For example
		1181	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1182	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1183	user-defined keymap using the C<builtin:> replacement:
		1184
		1185	URxvt.keysym.Insert: <my insert key sequence>
		1186	URxvt.keysym.S-Insert: builtin:
		1187
		1188	The first line defines a mapping for C<Insert> and I<any> combination
		1189	of modifiers. The second line re-establishes the default mapping for
		1190	C<Shift-Insert>.
		1191
		1192	The following example will map Control-Meta-1 and Control-Meta-2 to
		1193	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1194	font-switching at runtime:
		1195
		1196	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1197	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1198
		1199	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1200	info):
		1201
		1202	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1203	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1204
		1205	=item B<perl-ext-common>: I<string>
		1206
		1207	=item B<perl-ext>: I<string>
		1208
		1209	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1210	use in this terminal instance; option B<-pe>.
		1211
		1212	Extension names can be prefixed with a C<-> sign to prohibit using
		1213	them. This can be useful to selectively disable some extensions loaded
		1214	by default, or specified via the C<perl-ext-common> resource. For
		1215	example, C<default,-selection> will use all the default extension except
		1216	C<selection>.
		1217
		1218	Extension names can also be followed by an argument in angle brackets
		1219	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1220	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1221	multiple times with different arguments will pass multiple arguments to
		1222	the extension.
		1223
		1224	Each extension is looked up in the library directories, loaded if
		1225	necessary, and bound to the current terminal instance.
		1226
		1227	If both of these resources are the empty string, then the perl
		1228	interpreter will not be initialized. The idea behind two options is that
		1229	B<perl-ext-common> will be used for extensions that should be available to
		1230	all instances, while B<perl-ext> is used for specific instances.
		1231
		1232	=item B<perl-eval>: I<string>
		1233
		1234	Perl code to be evaluated when all extensions have been registered. See
		1235	the @@RXVT_NAME@@perl(3) manpage.
		1236
		1237	=item B<perl-lib>: I<path>
		1238
		1239	Colon-separated list of additional directories that hold extension
		1240	scripts. When looking for extensions specified by the C<perl> resource,
		1241	@@RXVT_NAME@@ will first look in these directories and then in
		1242	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1243
		1244	See the @@RXVT_NAME@@perl(3) manpage.
		1245
		1246	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1247
		1248	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1249	details.
		1250
		1251	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1252
		1253	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1254	for details.
		1255
		1256	=item B<searchable-scrollback:> I<keysym>
		1257
		1258	Sets the hotkey that starts the incremental scrollback buffer search
		1259	(default: C<M-s>).
		1260
		1261	=item B<urlLauncher>: I<string>
		1262
		1263	Specifies the program to be started with a URL argument. Used by the
		1264	C<selection-popup> and C<matcher> perl extensions.
		1265
		1266	=item B<transient-for>: I<windowid>
		1267
		1268	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1269
		1270	=item B<override-redirect>: I<boolean>
		1271
		1272	Compile I<frills>: Sets override-redirect for the terminal window, making
		1273	it almost invisible to window managers; option B<-override-redirect>.
		1274
		1275	=item B<iso14755_52:> I<boolean>
		1276
		1277	Turn on/off ISO 14755 5.2 mode (default enabled).
809		1278
810	=back	1279	=back
811		1280
812	=head1 THE SCROLLBAR	1281	=head1 THE SCROLLBAR
813		1282
…		…
827	the normal text selection/insertion, hold either the Shift or the Meta	1296	the normal text selection/insertion, hold either the Shift or the Meta
828	(Alt) key while performing the desired mouse action.	1297	(Alt) key while performing the desired mouse action.
829		1298
830	If mouse reporting mode is active, the normal scrollbar actions are	1299	If mouse reporting mode is active, the normal scrollbar actions are
831	disabled -- on the assumption that we are using a fullscreen	1300	disabled -- on the assumption that we are using a fullscreen
832	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1301	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
833	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1302	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
834	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1303	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
835	respectively.	1304	respectively.
836		1305
837	=head1 TEXT SELECTION AND INSERTION	1306	=head1 THE SELECTION: SELECTING AND PASTING TEXT
838		1307
839	The behaviour of text selection and insertion mechanism is similar to	1308	The behaviour of text selection and insertion/pasting mechanism is similar
840	I<xterm>(1).	1309	to I<xterm>(1).
841		1310
842	=over 4	1311	=over 4
843		1312
844	=item B<Selection>:	1313	=item B<Selecting>:
845		1314
846	Left click at the beginning of the region, drag to the end of the	1315	Left click at the beginning of the region, drag to the end of the region
847	region and release; Right click to extend the marked region; Left	1316	and release; Right click to extend the marked region; Left double-click
848	double-click to select a word; Left triple-click to select the entire	1317	to select a word; Left triple-click to select the entire logical line
849	line.	1318	(which can span multiple screen lines), unless modified by resource
		1319	B<tripleclickwords>.
850		1320
851	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1321	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
852	(Compile: frills) will create a rectangular selection instead of a normal	1322	(Compile: I<frills>) will create a rectangular selection instead of a
853	one.	1323	normal one. In this mode, every selected row becomes its own line in the
		1324	selection, and trailing whitespace is visually underlined and removed from
		1325	the selection.
854		1326
855	=item B<Insertion>:	1327	=item B<Pasting>:
856		1328
857	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1329	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
858	an B<@@RXVT_NAME@@> window causes the current text selection to be	1330	window causes the value of the PRIMARY selection (or CLIPBOARD with the
859	inserted as if it had been typed on the keyboard.	1331	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1332
		1333	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1334	inserted too.
860		1335
861	=back	1336	=back
862		1337
863	=head1 CHANGING FONTS	1338	=head1 CHANGING FONTS
864		1339
865	Changing fonts (or font sizes, respectively) via the keypad is not yet	1340	Changing fonts (or font sizes, respectively) via the keypad is not yet
866	supported in rxvt-unicode. Bug me if you need this.	1341	supported in rxvt-unicode. Bug me if you need this.
867		1342
868	You can, however, switch fonts at runtime using escape sequences (and	1343	You can, however, switch fonts at runtime using escape sequences, e.g.:
869	therefore using the menubar), e.g.:
870		1344
871	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1345	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1346
		1347	You can use keyboard shortcuts, too:
		1348
		1349	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1350	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
872		1351
873	rxvt-unicode will automatically re-apply these fonts to the output so far.	1352	rxvt-unicode will automatically re-apply these fonts to the output so far.
874		1353
875	=head1 ISO 14755 SUPPORT	1354	=head1 ISO 14755 SUPPORT
876		1355
877	ISO 14755 is a standard for entering and viewing unicode characters	1356	ISO 14755 is a standard for entering and viewing unicode characters
878	and character codes using the keyboard. It consists of 4 parts. The	1357	and character codes using the keyboard. It consists of 4 parts. The
879	first part is available rxvt-unicode has been compiled with	1358	first part is available if rxvt-unicode has been compiled with
880	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1359	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
881	with C<--enable-iso14755>.	1360	with C<--enable-iso14755>.
882		1361
883	=over 4	1362	=over 4
884		1363
885	=item 5.1: Basic method	1364	=item * 5.1: Basic method
886		1365
887	This allows you to enter unicode characters using their hexcode.	1366	This allows you to enter unicode characters using their hexcode.
888		1367
889	Start by pressing and holding both C<Control> and C<Shift>, then enter	1368	Start by pressing and holding both C<Control> and C<Shift>, then enter
890	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1369	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
897	address, which you cannot type. Fortunately, the card has the e-mail	1376	address, which you cannot type. Fortunately, the card has the e-mail
898	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1377	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
899	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1378	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
900	followed by releasing the modifier keys.	1379	followed by releasing the modifier keys.
901		1380
902	=item 5.2: Keyboard symbols entry method	1381	=item * 5.2: Keyboard symbols entry method
903		1382
904	This mode lets you input characters representing the keycap symbols of	1383	This mode lets you input characters representing the keycap symbols of
905	your keyboard, if representable in the current locale encoding.	1384	your keyboard, if representable in the current locale encoding.
906		1385
907	Start by pressing C<Control> and C<Shift> together, then releasing	1386	Start by pressing C<Control> and C<Shift> together, then releasing
908	them. The next special key (cursor keys, home etc.) you enter will not	1387	them. The next special key (cursor keys, home etc.) you enter will not
909	invoke it's usual function but instead will insert the corresponding	1388	invoke its usual function but instead will insert the corresponding
910	keycap symbol. The symbol will only be entered when the key has been	1389	keycap symbol. The symbol will only be entered when the key has been
911	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1390	released, otherwise pressing e.g. C<Shift> would enter the symbol for
912	C<ISO Level 2 Switch>, although your intention might have been to enter a	1391	C<ISO Level 2 Switch>, although your intention might have been to enter a
913	reverse tab (Shift-Tab).	1392	reverse tab (Shift-Tab).
914		1393
915	=item 5.3: Screen-selection entry method	1394	=item * 5.3: Screen-selection entry method
916		1395
917	While this is implemented already (it's basically the selection	1396	While this is implemented already (it's basically the selection
918	mechanism), it could be extended by displaying a unicode character map.	1397	mechanism), it could be extended by displaying a unicode character map.
919		1398
920	=item 5.4: Feedback method for identifying displayed characters for later input	1399	=item * 5.4: Feedback method for identifying displayed characters for later input
921		1400
922	This method lets you display the unicode character code associated with	1401	This method lets you display the unicode character code associated with
923	characters already displayed.	1402	characters already displayed.
924		1403
925	You enter this mode by holding down C<Control> and C<Shift> together, then	1404	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
937	With respect to conformance, rxvt-unicode is supposed to be compliant to	1416	With respect to conformance, rxvt-unicode is supposed to be compliant to
938	both scenario A and B of ISO 14755, including part 5.2.	1417	both scenario A and B of ISO 14755, including part 5.2.
939		1418
940	=head1 LOGIN STAMP	1419	=head1 LOGIN STAMP
941		1420
942	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1421	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
943	that it can be seen via the I<who(1)> command, and can accept messages.	1422	it can be seen via the I<who(1)> command, and can accept messages. To
944	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1423	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
945	some systems.	1424	on some systems or setgid to root or to some other group on others.
946		1425
947	=head1 COLORS AND GRAPHICS	1426	=head1 COLORS AND GRAPHICS
948		1427
949	In addition to the default foreground and background colours,	1428	In addition to the default foreground and background colours,
950	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1429	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
951	high-intensity bold/blink versions of the same). Here is a list of the	1430	high-intensity bold/blink versions of the same). Here is a list of the
952	colours with their B<rgb.txt> names.	1431	colours with their names.
953		1432
954	=begin table	1433	=begin table
955		1434
956	B<color0> (black) = Black	1435	B<color0> (black) = Black
957	B<color1> (red) = Red3	1436	B<color1> (red) = Red3
…		…
977	It is also possible to specify the colour values of B<foreground>,	1456	It is also possible to specify the colour values of B<foreground>,
978	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1457	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
979	a number 0-15, as a convenient shorthand to reference the colour name of	1458	a number 0-15, as a convenient shorthand to reference the colour name of
980	color0-color15.	1459	color0-color15.
981		1460
		1461	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1462	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1463	consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1464	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1465
		1466	Together, all those colours implement the 88 colour xterm colours. Only
		1467	the first 16 can be changed using resources currently, the rest can only
		1468	be changed via command sequences ("escape codes").
		1469
982	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1470	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
983	always swapping the foreground/background colours. This is in contrast to	1471	always swapping the foreground/background colours. This is in contrast to
984	I<xterm>(1) where the colours are only swapped if they have not otherwise	1472	I<xterm>(1) where the colours are only swapped if they have not otherwise
985	been specified. For example,	1473	been specified. For example,
986		1474
…		…
991	would yield White on Black, while on I<xterm>(1) it would yield Black	1479	would yield White on Black, while on I<xterm>(1) it would yield Black
992	on White.	1480	on White.
993		1481
994	=back	1482	=back
995		1483
		1484	=head2 ALPHA CHANNEL SUPPORT
		1485
		1486	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1487	their act together, rxvt-unicode will do it's own alpha channel management:
		1488
		1489	You can prefix any color with an opaquenes percentage enclosed in
		1490	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1491	(0-100) that specifies the opacity of the color, where C<0> is completely
		1492	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1493	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1494	is the recommended format to specify transparency values, and works with
		1495	all ways to specify a colour.
		1496
		1497	For complete control, rxvt-unicode also supports
		1498	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1499	specifications, where the additional C<aaaa> component specifies opacity
		1500	(alpha) values. The minimum value of C<0000> is completely transparent,
		1501	while C<ffff> is completely opaque). The two example colours from
		1502	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1503	C<rgba:0000/ff00/0000/f332>.
		1504
		1505	You probably need to specify B<"-depth 32">, too, to force a visual with
		1506	alpha channels, and have the luck that your X-server uses ARGB pixel
		1507	layout, as X is far from just supporting ARGB visuals out of the box, and
		1508	rxvt-unicode just fudges around.
		1509
		1510	For example, the following selects an almost completely transparent black
		1511	background, and an almost opaque pink foreground:
		1512
		1513	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1514
		1515	When not using a background image, then the interpretation of the
		1516	alpha channel is up to your compositing manager (most interpret it as
		1517	transparency of course).
		1518
		1519	When using a background pixmap or pseudo-transparency, then the background
		1520	colour will always behave as if it were completely transparent (so the
		1521	background image shows instead), regardless of how it was specified, while
		1522	other colours will either be transparent as specified (the background
		1523	image will show through) on servers supporting the RENDER extension, or
		1524	fully opaque on servers not supporting the RENDER EXTENSION.
		1525
		1526	Please note that due to bugs in Xft, specifying alpha values might result
		1527	in garbage being displayed when the X-server does not support the RENDER
		1528	extension.
		1529
996	=head1 ENVIRONMENT	1530	=head1 ENVIRONMENT
997		1531
998	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1532	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
999	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1533
1000	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1534	=over 4
1001	sets the environment variable B<DISPLAY> to specify which display	1535
1002	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1536	=item B<TERM>
1003	B<RXVTPATH> and B<PATH> to find XPM files.	1537
		1538	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1539	resources or on the command line.
		1540
		1541	=item B<COLORTERM>
		1542
		1543	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1544	compiled with background image support, and optionally with the added
		1545	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1546	screen.
		1547
		1548	=item B<COLORFGBG>
		1549
		1550	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1551	the colour code used as default foreground/text colour (or the string
		1552	C<default> to indicate that the default-colour escape sequence is to be
		1553	used), C<bg> is the colour code used as default background colour (or the
		1554	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1555	was compiled with background image support. Libraries like C<ncurses>
		1556	and C<slang> can (and do) use this information to optimize screen output.
		1557
		1558	=item B<WINDOWID>
		1559
		1560	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1561	window, which usually has subwindows for the scrollbar, the terminal
		1562	window and so on).
		1563
		1564	=item B<TERMINFO>
		1565
		1566	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1567	C<--with-terminfo=PATH>.
		1568
		1569	=item B<DISPLAY>
		1570
		1571	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1572	display in its child processes if C<-display> isn't used to override. It
		1573	defaults to C<:0> if it doesn't exist.
		1574
		1575	=item B<SHELL>
		1576
		1577	The shell to be used for command execution, defaults to C</bin/sh>.
		1578
		1579	=item B<RXVT_SOCKET>
		1580
		1581	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1582	@@RXVT_NAME@@d(1).
		1583
		1584	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1585
		1586	=item B<HOME>
		1587
		1588	Used to locate the default directory for the unix domain socket for
		1589	daemon communications and to locate various resource files (such as
		1590	C<.Xdefaults>)
		1591
		1592	=item B<XAPPLRESDIR>
		1593
		1594	Directory where various X resource files are being located.
		1595
		1596	=item B<XENVIRONMENT>
		1597
		1598	If set and accessible, gives the name of a X resource file to be loaded by
		1599	@@RXVT_NAME@@.
		1600
		1601	=back
1004		1602
1005	=head1 FILES	1603	=head1 FILES
1006		1604
1007	=over 4	1605	=over 4
1008		1606
1009	=item B</etc/utmp>
1010
1011	System file for login records.
1012
1013	=item B</usr/lib/X11/rgb.txt>	1607	=item B</usr/lib/X11/rgb.txt>
1014		1608
1015	Color names.	1609	Color names.
1016		1610
1017	=back	1611	=back
1018		1612
1019	=head1 SEE ALSO	1613	=head1 SEE ALSO
1020		1614
1021	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1615	@@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)
1022
1023	=head1 BUGS
1024
1025	Check the BUGS file for an up-to-date list.
1026
1027	Cursor change support is not yet implemented.
1028
1029	Click-and-drag doesn't work with X11 mouse report overriding.
1030		1616
1031	=head1 CURRENT PROJECT COORDINATOR	1617	=head1 CURRENT PROJECT COORDINATOR
1032		1618
1033	=over 4	1619	=over 4
1034		1620
1035	=item Project Coordinator	1621	=item Project Coordinator
1036		1622
1037	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1623	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1038		1624
1039	=item Web page maintainter	1625	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1040
1041	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1042
1043	L<@@RXVT_WEBPAGE@@>
1044		1626
1045	=back	1627	=back
1046		1628
1047	=head1 AUTHORS	1629	=head1 AUTHORS
1048		1630
…		…
1070		1652
1071	Project Coordinator (changes.txt 2.21a to 2.4.5)	1653	Project Coordinator (changes.txt 2.21a to 2.4.5)
1072		1654
1073	=item Geoff Wing L<< <gcw@pobox.com> >>	1655	=item Geoff Wing L<< <gcw@pobox.com> >>
1074		1656
1075	Rewrote screen display and text selection routines. Project Coordinator	1657	Rewrote screen display and text selection routines.
		1658
1076	(changes.txt 2.4.6 - rxvt-unicode)	1659	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1077		1660
1078	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1661	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1079		1662
1080	Forked rxvt-unicode, rewrote most of the display code and internal	1663	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1081	character handling to store text in unicode, improve xterm	1664	extension, random hacks, numerous bugfixes and extensions.
1082	compatibility and apply numerous other bugfixes and extensions.
1083		1665
1084	Project Coordinator (Changes 1.0 -)	1666	Project Coordinator (Changes 1.0 -)
1085		1667
		1668	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1669
		1670	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1671
1086	=back	1672	=back
1087		1673

Diff Legend

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