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.32 by root, Sat Oct 9 11:18:12 2004 UTC vs.
Revision 1.175 by root, Mon Apr 12 17:06:55 2010 UTC

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

Diff Legend

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