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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.158 by root, Wed Jan 23 14:33:42 2008 UTC

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

Diff Legend

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