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

Diff Legend

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