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

Diff Legend

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