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

Diff Legend

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