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

Diff Legend

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