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.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.202 by sf-exg, Thu Aug 11 08:37:17 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	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	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
27	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
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	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
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	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
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	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
40	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
41	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
42	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
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
46	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
47	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
48	to choose any font for any script freely.	51	to choose any font for any script freely.
49		52
50	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
51	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
52	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
53	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
54		57
55	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
56	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
57	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
58	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
59	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
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
62		65
63	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
66		69
67	=head1 OPTIONS	70	=head1 OPTIONS
68		71
69	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
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	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>
95	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
96	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]
97		110
98	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
99		112
100	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
101		114
…		…
103		116
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		118
106	=item B<-j>|B<+j>	119	=item B<-j>|B<+j>
107		120
108	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		122
110	=item B<-ip>|B<+ip>	123	=item B<-ss>|B<+ss>
111		124
112	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>.
113	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.
114		133
115	=item B<-fade> I<number>	134	=item B<-fade> I<number>
116		135
117	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>.
118		144
119	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
120		146
121	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	148	resource I<tintColor>.
123	option that can be used to brighten or darken the image in addition to
124	tinting it.
125		149
126	=item B<-sh>	150	=item B<-sh> I<number>
127		151
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
129	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
130	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>.
131		179
132	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
133		181
134	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
135		183
136	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
137		185
138	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
139		187
140	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
141		189
142	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
143	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
144	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
145	command-line; resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
146		194
147	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
148		196
149	The cursor colour; resource B<cursorColor>.	197	The cursor colour; resource B<cursorColor>.
150		198
…		…
162	resource B<borderColor>.	210	resource B<borderColor>.
163		211
164	=item B<-fn> I<fontlist>	212	=item B<-fn> I<fontlist>
165		213
166	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
167	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
168	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
169	smaller, but not (in general) larger. A (hopefully) reasonable default	217	smaller, but not (in general) larger. A (hopefully) reasonable default
170	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.
171		219
172	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
173	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:>,
174	e.g.:	222	e.g.:
175		223
176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	224	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	225	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
179	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
180	section of @@RXVT_NAME@@(7).	228	section of @@RXVT_NAME@@(7).
181		229
182	=item B<-fb> I<fontlist>	230	=item B<-fb> I<fontlist>
183		231
184	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
185	be printed. See resource B<boldFont> for details.	233	are to be printed. See resource B<boldFont> for details.
186		234
187	=item B<-fi> I<fontlist>	235	=item B<-fi> I<fontlist>
188		236
189	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>
190	be printed. See resource B<italicFont> for details.	238	characters are to be printed. See resource B<italicFont> for details.
191		239
192	=item B<-fbi> I<fontlist>	240	=item B<-fbi> I<fontlist>
193		241
194	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
195	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.
196		251
197	=item B<-name> I<name>	252	=item B<-name> I<name>
198		253
199	Specify the application name under which resources are to be obtained,	254	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	255	rather than the default executable file name. Name should not contain
…		…
216		271
217	=item B<-sb>|B<+sb>	272	=item B<-sb>|B<+sb>
218		273
219	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
220		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
221	=item B<-si>|B<+si>	285	=item B<-si>|B<+si>
222		286
223	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
224	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
225		289
…		…
231	=item B<-sw>|B<+sw>	295	=item B<-sw>|B<+sw>
232		296
233	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.
234	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
235	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
236
237	=item B<-sr>|B<+sr>
238
239	Put scrollbar on right/left; resource B<scrollBar_right>.
240
241	=item B<-st>|B<+st>
242
243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
244	resource B<scrollBar_floating>.
245		300
246	=item B<-ptab>|B<+ptab>	301	=item B<-ptab>|B<+ptab>
247		302
248	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
249	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
…		…
253		308
254	=item B<-bc>|B<+bc>	309	=item B<-bc>|B<+bc>
255		310
256	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
257		312
		313	=item B<-uc>|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
258	=item B<-iconic>	317	=item B<-iconic>
259		318
260	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
261	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
262		321
…		…
278		337
279	=item B<-bl>	338	=item B<-bl>
280		339
281	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.
282	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
283	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>.
284		356
285	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
286		358
287	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
288	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
289	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>.
290		369
291	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
292		371
293	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
294	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
303	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
304	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
305	run the program specified by the B<SHELL> environment variable or,	384	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	385	failing that, I<sh(1)>.
307		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
308	=item B<-title> I<text>	392	=item B<-title> I<text>
309		393
310	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
311	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
312	application name; resource B<title>.	396	application name; resource B<title>.
…		…
343	for more info.	427	for more info.
344		428
345	=item B<-tcw>	429	=item B<-tcw>
346		430
347	Change the meaning of triple-click selection with the left mouse	431	Change the meaning of triple-click selection with the left mouse
		432	button. Only effective when the original (non-perl) selection code is
348	button. Instead of selecting a full line it will extend the selection the	433	in-use. Instead of selecting a full line it will extend the selection to
349	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
350		435
351	=item B<-insecure>	436	=item B<-insecure>
352		437
353	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
354	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
368	=item B<-ssr>|B<+ssr>	453	=item B<-ssr>|B<+ssr>
369		454
370	Turn on/off secondary screen scroll (default enabled); resource	455	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	456	B<secondaryScroll>.
372		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
		471	=item B<-xrm> I<string>
		472
		473	Works like the X Toolkit option of the same name, by adding the I<string>
		474	as if it were specified in a resource file. Resource values specified this
		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
373	=item B<-keysym.>I<sym>: I<string>	484	=item B<-keysym.>I<sym> I<string>
374		485
375	Remap a key symbol. See resource B<keysym>.	486	Remap a key symbol. See resource B<keysym>.
376		487
377	=item B<-embed>: I<windowid>	488	=item B<-embed> I<windowid>
378		489
379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	490	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380	which enables applications to easily embed a terminal.	491	which enables applications to easily embed a terminal.
381		492
382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	493	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	494	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384	quite a bit, so don't expect it to keep some specific state. It's best to	495	quite a bit, so don't expect it to keep some specific state. It's best to
385	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.	496	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
386		497
		498	The window will not be destroyed when @@RXVT_NAME@@ exits.
		499
387	It might be useful to know that @@RXVT_NAME@@ will not close file	500	It might be useful to know that @@RXVT_NAME@@ will not close file
388	descriptors passed to it (except for stdin/out/err, of course), so you	501	descriptors passed to it (except for stdin/out/err, of course), so you
389	can use file descriptors to communicate with the programs within the	502	can use file descriptors to communicate with the programs within the
390	terminal. This works regardless of wether the C<-embed> option was used or	503	terminal. This works regardless of whether the C<-embed> option was used or
391	not.	504	not.
392		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.
		549
393	=back	550	=back
394		551
395	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
396		553
397	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
398	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
399		557
400	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
401	Xresource data: using the X libraries (Xrm*-functions) or internal	559	distribution do also load settings from the B<~/.Xresources> file when X
402	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
403	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	561	with later settings overwriting earlier ones:
404	resources using X11 tools like B<xrdb>. Many distribution do also load
405	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
406	will consult the following files/resources in order, with later settings
407	overwriting earlier ones:
408		562
409	1. system-wide app-defaults file, either locale-dependent OR global
410	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
411	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
412	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
413	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
414		569
415	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
416	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
417	set in XAPPLOADDIR/URxvt (compile-time defined: usually
418	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
419	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
420	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
421	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
422	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
423	easily configured, while the class name B<URxvt> allows resources	573	configured, while the class name B<URxvt> allows resources unique to
424	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	574	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
425	shared between different B<@@RXVT_NAME@@> configurations. If no	575	configurations. If no resources are specified, suitable defaults will
426	resources are specified, suitable defaults will be used. Command-line	576	be used. Command-line arguments can be used to override resource
427	arguments can be used to override resource settings. The following	577	settings. The following resources are supported (you might want to
428	resources are allowed:	578	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		579	extensions not documented here):
429		580
430	=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.
431		594
432	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
433		596
434	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
435	option B<-geometry>.	598	option B<-geometry>.
…		…
449	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
450	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
451	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
452	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,
453	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
454	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
455		618
456	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
457	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
458		621
459	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
…		…
470	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
471		634
472	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
473	foreground colour is the default.	636	foreground colour is the default.
474		637
475	=item B<colorRV:> I<colour>
476
477	Use the specified colour as the background for reverse video
478	characters.
479
480	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
481		639
482	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
483	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.
484		652
485	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
486		654
487	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
488	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
495		663
496	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
497		665
498	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
499	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
500	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
501		669
502	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
503		671
504	B<True>: specify that jump scrolling should be used. When scrolling	672	B<True>: specify that jump scrolling should be used. When receiving lots
505	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
506	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>.
507		679
508	=item B<inheritPixmap:> I<boolean>	680	=item B<skipScroll:> I<boolean>
509		681
510	B<True>: make the background inherit the parent windows' pixmap, giving	682	B<True>: (the default) specify that skip scrolling should be used. When
511	artificial transparency. B<False>: do not inherit the parent windows'	683	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
512	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.
513		698
514	=item B<fading:> I<number>	699	=item B<fading:> I<number>
515		700
516	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>.
517		707
518	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
519		709
520	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>.
521		715
522	=item B<shading:> I<number>	716	=item B<shading:> I<number>
523		717
524	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
525	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>.
526		733
527	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
528		735
529	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
530		737
531	=item B<troughColor:> I<colour>	738	=item B<troughColor:> I<colour>
532		739
533	Use the specified colour for the scrollbar's trough area [default	740	Use the specified colour for the scrollbar's trough area [default
534	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	741	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
535		742
536	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
537		744
538	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
539	and the text.	746	and the text.
540		747
541	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
542		749
543	Use the specified XPM file (note the `.xpm' extension is optional) for	750	Use the specified image file for the background and also
544	the background and also optionally specify its scaling with a geometry	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
545	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
546	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
547	centre (percent). A scale of 0 displays the image with tiling. A scale	754	centre (percent). A scale of 0 disables scaling.
548	of 1 displays the image without any scaling. A scale of 2 to 9	755	The maximum permitted scale is 1000.
549	specifies an integer number of images in that direction. No image will	756	Additional operations can be specified after colon B<:op1:op2...>.
550	be magnified beyond 10 times its original size. The maximum permitted	757	Supported operations are:
551	scale is 1000. [default 0x0+50+50]
552		758
553	=item B<menu:> I<file[;tag]>	759	op=tile enables tiling
		760	op=pscale enables proportional scaling
		761	op=root use the position of the terminal window relative to the root
		762	window as the image offset, simulating a root window background
554		763
555	Read in the specified menu file (note the `.menu' extension is	764	Alternatively, a predefined set of templates can be used to achieve
556	optional) and also optionally specify a starting tag to find. See the	765	the most common setups:
557	reference documentation for details on the syntax for the menuBar.	766
		767	style=tiled the image is tiled with no scaling
		768	style=aspect-stretched the image is scaled to fill the whole window maintaining
		769	the aspect ratio and centered
		770	style=stretched the image is scaled to fill the whole window
		771	style=centered the image is centered with no scaling
		772	style=root-tiled the image is tiled with no scaling and using 'op=root' positioning
		773
		774	If multiple templates are specified the last one wins. Note that a
		775	template overrides all the scale, position and operations settings.
		776	Indeed, the templates can be specified in terms of low level settings
		777	as follows:
		778
		779	style=tiled 0x0+0+0:op=tile
		780	style=aspect-stretched +50+50:op=pscale
		781	style=stretched 100x100
		782	style=centered 0x0+50+50
		783	style=root-tiled 0x0:op=tile:op=root
		784
		785	If used in conjunction with B<-tr> option, the specified pixmap will be
		786	blended over the transparent background using alpha-blending. If I<afterimage>
		787	support has been compiled in it is possible to choose other blending
		788	types with B<-blt "type"> option.
558		789
559	=item B<path:> I<path>	790	=item B<path:> I<path>
560		791
561	Specify the colon-delimited search path for finding files (XPM and	792	Specify the colon-delimited search path for finding background image files.
562	menus), in addition to the paths specified by the B<RXVTPATH> and
563	B<PATH> environment variables.
564		793
565	=item B<font:> I<fontlist>	794	=item B<font:> I<fontlist>
566		795
567	Select the fonts to be used. This is a comma separated list of font	796	Select the fonts to be used. This is a comma separated list of font names
568	names that are used in turn when trying to display Unicode characters.	797	that are checked in order when trying to find glyphs for characters. The
569	The first font defines the cell size for characters; other fonts might	798	first font defines the cell size for characters; other fonts might be
570	be smaller, but not larger. A reasonable default font list is always	799	smaller, but not (in general) larger. A (hopefully) reasonable default
571	appended to it. option B<-fn>.	800	font list is always appended to it; option B<-fn>.
572		801
573	Each font can either be a standard X11 core font (XLFD) name, with	802	Each font can either be a standard X11 core font (XLFD) name, with
574	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	803	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
575		804
576	In addition, each font can be prefixed with additional hints and	805	In addition, each font can be prefixed with additional hints and
…		…
578	hint currently is C<codeset=codeset-name>, and this is only used for Xft	807	hint currently is C<codeset=codeset-name>, and this is only used for Xft
579	fonts.	808	fonts.
580		809
581	For example, this font resource	810	For example, this font resource
582		811
583	URxvt*font: 9x15bold,\	812	URxvt.font: 9x15bold,\
584	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	813	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
585	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	814	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
586	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	815	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
587	xft:Code2000:antialias=false	816	xft:Code2000:antialias=false
588		817
…		…
591	it is named first) and thus defines the character cell grid to be 9 pixels	820	it is named first) and thus defines the character cell grid to be 9 pixels
592	wide and 15 pixels high.	821	wide and 15 pixels high.
593		822
594	The second font is just used to add additional unicode characters not in	823	The second font is just used to add additional unicode characters not in
595	the base font, likewise the third, which is unfortunately non-bold, but	824	the base font, likewise the third, which is unfortunately non-bold, but
596	the bold version of the font does contain less characters, so this is a	825	the bold version of the font does contain fewer characters, so this is a
597	useful supplement.	826	useful supplement.
598		827
599	The third font is an Xft font with aliasing turned off, and the characters	828	The third font is an Xft font with aliasing turned off, and the characters
600	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	829	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
601	contains other characters, but we are not interested in them.	830	contains other characters, but we are not interested in them.
…		…
622	not possible, replacement fonts of the desired shape will be tried.	851	not possible, replacement fonts of the desired shape will be tried.
623		852
624	If set, but empty, then this specific style is disabled and the normal	853	If set, but empty, then this specific style is disabled and the normal
625	text font will being used for the given style.	854	text font will being used for the given style.
626		855
627	=item B<selectstyle:> I<mode>	856	=item B<intensityStyles:> I<boolean>
628		857
629	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	858	When font styles are not enabled, or this option is enabled (B<True>,
630	xterm style with 2.20 old word selection, or anything else which gives	859	option B<-is>, the default), bold/blink font styles imply high
631	xterm style selection.	860	intensity foreground/background colours. Disabling this option (B<False>,
632		861	option B<+is>) disables this behaviour, the high intensity colours are not
633	=item B<scrollstyle:> I<mode>	862	reachable.
634
635	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
636	the author's favourite..
637		863
638	=item B<title:> I<string>	864	=item B<title:> I<string>
639		865
640	Set window title string, the default title is the command-line	866	Set window title string, the default title is the command-line
641	specified after the B<-e> option, if any, otherwise the application	867	specified after the B<-e> option, if any, otherwise the application
…		…
650	=item B<mapAlert:> I<boolean>	876	=item B<mapAlert:> I<boolean>
651		877
652	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	878	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
653	de-iconify (map) on receipt of a bell character [default].	879	de-iconify (map) on receipt of a bell character [default].
654		880
		881	=item B<urgentOnBell:> I<boolean>
		882
		883	B<True>: set the urgency hint for the wm on receipt of a bell character.
		884	B<False>: do not set the urgency hint [default].
		885
		886	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		887
655	=item B<visualBell:> I<boolean>	888	=item B<visualBell:> I<boolean>
656		889
657	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	890	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
658	B<False>: no visual bell [default]; option B<+vb>.	891	B<False>: no visual bell [default]; option B<+vb>.
659		892
…		…
673		906
674	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	907	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
675	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	908	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
676	B<Shift-Print> to include the scrollback as well.	909	B<Shift-Print> to include the scrollback as well.
677		910
		911	The string will be interpreted as if typed into the shell as-is.
		912
		913	Example:
		914
		915	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		916
		917	This creates a new file in your home directory with the screen contents
		918	every time you hit C<Print>.
		919
		920	=item B<scrollstyle:> I<mode>
		921
		922	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		923	the author's favourite.
		924
		925	=item B<thickness:> I<number>
		926
		927	Set the scrollbar width in pixels.
		928
678	=item B<scrollBar:> I<boolean>	929	=item B<scrollBar:> I<boolean>
679		930
680	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	931	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
681	disable the scrollbar; option B<+sb>.	932	disable the scrollbar; option B<+sb>.
682		933
…		…
701	B<False>: do not scroll to bottom when tty receives output; option	952	B<False>: do not scroll to bottom when tty receives output; option
702	B<+si>.	953	B<+si>.
703		954
704	=item B<scrollWithBuffer:> I<boolean>	955	=item B<scrollWithBuffer:> I<boolean>
705		956
706	B<True>: scroll with scrollback buffer when tty receives new lines (and	957	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
707	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	958	try to show the same lines) and B<scrollTtyOutput> is False; option
708	with scrollback buffer when tty recieves new lines; option B<-sw>.	959	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		960	new lines; option B<+sw>.
709		961
710	=item B<scrollTtyKeypress:> I<boolean>	962	=item B<scrollTtyKeypress:> I<boolean>
711		963
712	B<True>: scroll to bottom when a non-special key is pressed. Special keys	964	B<True>: scroll to bottom when a non-special key is pressed. Special keys
713	are those which are intercepted by rxvt-unicode for special handling and	965	are those which are intercepted by rxvt-unicode for special handling and
…		…
732	=item B<borderLess:> I<boolean>	984	=item B<borderLess:> I<boolean>
733		985
734	Set MWM hints to request a borderless window, i.e. if honoured by the	986	Set MWM hints to request a borderless window, i.e. if honoured by the
735	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	987	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
736		988
		989	=item B<skipBuiltinGlyphs:> I<boolean>
		990
		991	Compile I<frills>: Disable the usage of the built-in block graphics/line
		992	drawing characters and just rely on what the specified fonts provide. Use
		993	this if you have a good font and want to use its block graphic glyphs;
		994	option B<-sbg>.
		995
737	=item B<termName:> I<termname>	996	=item B<termName:> I<termname>
738		997
739	Specifies the terminal type name to be set in the B<TERM> environment	998	Specifies the terminal type name to be set in the B<TERM> environment
740	variable; option B<-tn>.	999	variable; option B<-tn>.
741		1000
742	=item B<linespace:> I<number>	1001	=item B<lineSpace:> I<number>
743		1002
744	Specifies number of lines (pixel height) to insert between each row of	1003	Specifies number of lines (pixel height) to insert between each row of
745	the display [default 0]; option B<-lsp>.	1004	the display [default 0]; option B<-lsp>.
746		1005
747	=item B<meta8:> I<boolean>	1006	=item B<meta8:> I<boolean>
…		…
761		1020
762	=item B<cursorBlink:> I<boolean>	1021	=item B<cursorBlink:> I<boolean>
763		1022
764	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1023	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
765	option B<-bc>.	1024	option B<-bc>.
		1025
		1026	=item B<cursorUnderline:> I<boolean>
		1027
		1028	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1029	option B<-uc>.
766		1030
767	=item B<pointerBlank:> I<boolean>	1031	=item B<pointerBlank:> I<boolean>
768		1032
769	B<True>: blank the pointer when a key is pressed or after a set number	1033	B<True>: blank the pointer when a key is pressed or after a set number
770	of seconds of inactivity. B<False>: the pointer is always visible	1034	of seconds of inactivity. B<False>: the pointer is always visible
…		…
778		1042
779	Mouse pointer background colour.	1043	Mouse pointer background colour.
780		1044
781	=item B<pointerBlankDelay:> I<number>	1045	=item B<pointerBlankDelay:> I<number>
782		1046
783	Specifies number of seconds before blanking the pointer [default 2].	1047	Specifies number of seconds before blanking the pointer [default 2]. Use a
		1048	large number (e.g. C<987654321>) to effectively disable the timeout.
784		1049
785	=item B<backspacekey:> I<string>	1050	=item B<backspacekey:> I<string>
786		1051
787	The string to send when the backspace key is pressed. If set to B<DEC>	1052	The string to send when the backspace key is pressed. If set to B<DEC>
788	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1053	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
789	(code 8) - which can be reversed with the appropriate DEC private mode	1054	(code 8) - which can be reversed with the appropriate DEC private mode
790	escape sequence.	1055	escape sequence.
791		1056
792	=item B<deletekey:> I<string>	1057	=item B<deletekey:> I<string>
793		1058
…		…
795	pressed. If unset it will send the sequence traditionally associated	1060	pressed. If unset it will send the sequence traditionally associated
796	with the B<Execute> key.	1061	with the B<Execute> key.
797		1062
798	=item B<cutchars:> I<string>	1063	=item B<cutchars:> I<string>
799		1064
800	The characters used as delimiters for double-click word selection. The	1065	The characters used as delimiters for double-click word selection
801	built-in default:	1066	(whitespace delimiting is added automatically if resource is given).
802		1067
		1068	When the perl selection extension is in use (the default if compiled
		1069	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1070	characters will be created (if the resource exists, otherwise, no regex
		1071	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1072
		1073	When the selection extension is not used, only ISO-8859-1 characters can
		1074	be used. If not specified, the built-in default is used:
		1075
803	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1076	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
804		1077
805	=item B<preeditType:> I<style>	1078	=item B<preeditType:> I<style>
806		1079
807	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1080	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
808		1081
…		…
813	=item B<imLocale:> I<name>	1086	=item B<imLocale:> I<name>
814		1087
815	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	1088	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
816	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	1089	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
817	input extension to be able to input japanese characters while staying in	1090	input extension to be able to input japanese characters while staying in
818	another locale. option B<-imlocale>.	1091	another locale; option B<-imlocale>.
819		1092
820	=item B<imFont:> I<fontset>	1093	=item B<imFont:> I<fontset>
821		1094
822	Specify the font-set used for XIM styles C<OverTheSpot> or	1095	Specify the font-set used for XIM styles C<OverTheSpot> or
823	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	1096	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
828		1101
829	=item B<tripleclickwords:> I<boolean>	1102	=item B<tripleclickwords:> I<boolean>
830		1103
831	Change the meaning of triple-click selection with the left mouse	1104	Change the meaning of triple-click selection with the left mouse
832	button. Instead of selecting a full line it will extend the selection to	1105	button. Instead of selecting a full line it will extend the selection to
833	the end of the logical line only. option B<-tcw>.	1106	the end of the logical line only; option B<-tcw>.
834		1107
835	=item B<insecure:> I<boolean>	1108	=item B<insecure:> I<boolean>
836		1109
837	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1110	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
838	echo arbitrary strings like the icon name or the locale. This could be	1111	echo arbitrary strings like the icon name or the locale. This could be
839	abused if somebody gets 8-bit-clean access to your display, whether	1112	abused if somebody gets 8-bit-clean access to your display, whether
840	throuh a mail client displaying mail bodies unfiltered or though	1113	through a mail client displaying mail bodies unfiltered or through
841	write(1). Therefore, these sequences are disabled by default. (Note	1114	write(1) or any other means. Therefore, these sequences are disabled by
842	that other terminals, including xterm, have these sequences	1115	default. (Note that many other terminals, including xterm, have these
843	enabled by default). You can enable them by setting this boolean	1116	sequences enabled by default, which doesn't make it safer, though).
844	resource or specifying B<-insecure> as an option. At the moment, this	1117
845	enabled display-answer, locale, findfont, icon label and window title	1118	You can enable them by setting this boolean resource or specifying
846	requests as well as dynamic menubar dispatch.	1119	B<-insecure> as an option. At the moment, this enables display-answer,
		1120	locale, findfont, icon label and window title requests.
847		1121
848	=item B<modifier:> I<modifier>	1122	=item B<modifier:> I<modifier>
849		1123
850	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1124	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
851	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1125	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
855		1129
856	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1130	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
857	character is passed through. It may contain escape values as described	1131	character is passed through. It may contain escape values as described
858	in the entry on B<keysym> following.	1132	in the entry on B<keysym> following.
859		1133
860	=item B<secondaryScreen:> I<bool>	1134	=item B<secondaryScreen:> I<boolean>
861		1135
862	Turn on/off secondary screen (default enabled).	1136	Turn on/off secondary screen (default enabled).
863		1137
864	=item B<secondaryScroll:> I<bool>	1138	=item B<secondaryScroll:> I<boolean>
865		1139
866	Turn on/off secondary screen scroll (default enabled). If the this	1140	Turn on/off secondary screen scroll (default enabled). If this
867	option is enabled, scrolls on the secondary screen will change the	1141	option is enabled, scrolls on the secondary screen will change the
868	scrollback buffer and switching to/from the secondary screen will	1142	scrollback buffer and, when secondaryScreen is off, switching
869	instead scroll the screen up.	1143	to/from the secondary screen will instead scroll the screen up.
		1144
		1145	=item B<hold>: I<boolean>
		1146
		1147	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1148	will not immediately destroy its window when the program executed within
		1149	it exits. Instead, it will wait till it is being killed or closed by the
		1150	user.
		1151
		1152	=item B<chdir>: I<path>
		1153
		1154	Sets the working directory for the shell (or the command specified via
		1155	B<-e>). The I<path> must be an absolute path and it must exist for
		1156	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1157	directory will be used; option B<-cd>.
870		1158
871	=item B<keysym.>I<sym>: I<string>	1159	=item B<keysym.>I<sym>: I<string>
872		1160
873	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1161	Compile I<frills>: Associate I<string> with keysym I<sym>. The
874	intervening resource name B<keysym.> cannot be omitted.	1162	intervening resource name B<keysym.> cannot be omitted.
…		…
888	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1176	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
889	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1177	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
890	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1178	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
891	performed in an exact manner; however, the closest match is assured.	1179	performed in an exact manner; however, the closest match is assured.
892		1180
893	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1181	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
894	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1182	number), see RESOURCES in C<man 7 X> for further details.
895	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
896	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
897	can start or end with whitespace.
898
899	Please note that you need to double the C<\> when using
900	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
901	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
902	@@RXVT_NAME@@'s own processing).
903		1183
904	You can define a range of keysyms in one shot by providing a I<string>	1184	You can define a range of keysyms in one shot by providing a I<string>
905	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1185	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
906	should be a character not used by the strings.	1186	should be a character not used by the strings.
907		1187
908	Its usage can be demonstrated by an example:	1188	Its usage can be demonstrated by an example:
909		1189
910	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>	1190	URxvt.keysym.M-C-0x61: list|\033<|abc|>
911		1191
912	The above line is equivalent to the following three lines:	1192	The above line is equivalent to the following three lines:
913		1193
914	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1194	URxvt.keysym.Meta-Control-0x61: \033<a>
915	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1195	URxvt.keysym.Meta-Control-0x62: \033<b>
916	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1196	URxvt.keysym.Meta-Control-0x63: \033<c>
917		1197
918	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1198	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
919	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1199	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
920	example the following means "change the current locale to C<zh_CN.GBK>	1200	example the following means "change the current locale to C<zh_CN.GBK>
921	when Control-Meta-c is being pressed":	1201	when Control-Meta-c is being pressed":
922		1202
923	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1203	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
924		1204
		1205	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1206	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1207	manpage. For example, the F<selection> extension (activated via
		1208	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1209
		1210	URxvt.keysym.M-C-c: perl:selection:rot13
		1211
		1212	Due the the large number of modifier combinations, a defined key mapping
		1213	will match if I<at least> the specified identifiers are being set, and
		1214	no other key mappings with those and more bits are being defined. That
		1215	means that defining a key map for C<a> will automatically provide
		1216	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1217	mappings themselves.
		1218
		1219	Unfortunately, this will override built-in key mappings. For example
		1220	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1221	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1222	user-defined keymap using the C<builtin:> replacement:
		1223
		1224	URxvt.keysym.Insert: <my insert key sequence>
		1225	URxvt.keysym.S-Insert: builtin:
		1226
		1227	The first line defines a mapping for C<Insert> and I<any> combination
		1228	of modifiers. The second line re-establishes the default mapping for
		1229	C<Shift-Insert>.
		1230
925	The following example will map Control-Meta-1 and Control-Meta-2 to	1231	The following example will map Control-Meta-1 and Control-Meta-2 to
926	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1232	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
927	font-switching at runtime:	1233	font-switching at runtime:
928		1234
929	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1235	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
932	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1238	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
933	info):	1239	info):
934		1240
935	URxvt.keysym.M-C-3: command:\033[8;25;80t	1241	URxvt.keysym.M-C-3: command:\033[8;25;80t
936	URxvt.keysym.M-C-4: command:\033[8;48;110t	1242	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1243
		1244	=item B<perl-ext-common>: I<string>
		1245
		1246	=item B<perl-ext>: I<string>
		1247
		1248	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1249	use in this terminal instance; option B<-pe>.
		1250
		1251	Extension names can be prefixed with a C<-> sign to prohibit using
		1252	them. This can be useful to selectively disable some extensions loaded
		1253	by default, or specified via the C<perl-ext-common> resource. For
		1254	example, C<default,-selection> will use all the default extension except
		1255	C<selection>.
		1256
		1257	Extension names can also be followed by an argument in angle brackets
		1258	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1259	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1260	multiple times with different arguments will pass multiple arguments to
		1261	the extension.
		1262
		1263	Each extension is looked up in the library directories, loaded if
		1264	necessary, and bound to the current terminal instance.
		1265
		1266	If both of these resources are the empty string, then the perl
		1267	interpreter will not be initialized. The idea behind two options is that
		1268	B<perl-ext-common> will be used for extensions that should be available to
		1269	all instances, while B<perl-ext> is used for specific instances.
		1270
		1271	=item B<perl-eval>: I<string>
		1272
		1273	Perl code to be evaluated when all extensions have been registered. See
		1274	the @@RXVT_NAME@@perl(3) manpage.
		1275
		1276	=item B<perl-lib>: I<path>
		1277
		1278	Colon-separated list of additional directories that hold extension
		1279	scripts. When looking for extensions specified by the C<perl> resource,
		1280	@@RXVT_NAME@@ will first look in these directories and then in
		1281	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1282
		1283	See the @@RXVT_NAME@@perl(3) manpage.
		1284
		1285	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1286
		1287	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1288	details.
		1289
		1290	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1291
		1292	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1293	for details.
		1294
		1295	=item B<searchable-scrollback:> I<keysym>
		1296
		1297	Sets the hotkey that starts the incremental scrollback buffer search
		1298	(default: C<M-s>).
		1299
		1300	=item B<urlLauncher>: I<string>
		1301
		1302	Specifies the program to be started with a URL argument. Used by the
		1303	C<selection-popup> and C<matcher> perl extensions.
		1304
		1305	=item B<transient-for>: I<windowid>
		1306
		1307	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1308
		1309	=item B<override-redirect>: I<boolean>
		1310
		1311	Compile I<frills>: Sets override-redirect for the terminal window, making
		1312	it almost invisible to window managers; option B<-override-redirect>.
		1313
		1314	=item B<iso14755:> I<boolean>
		1315
		1316	Turn on/off ISO 14755 (default enabled).
		1317
		1318	=item B<iso14755_52:> I<boolean>
		1319
		1320	Turn on/off ISO 14755 5.2 mode (default enabled).
937		1321
938	=back	1322	=back
939		1323
940	=head1 THE SCROLLBAR	1324	=head1 THE SCROLLBAR
941		1325
…		…
960	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1344	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
961	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1345	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
962	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1346	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
963	respectively.	1347	respectively.
964		1348
965	=head1 TEXT SELECTION AND INSERTION	1349	=head1 THE SELECTION: SELECTING AND PASTING TEXT
966		1350
967	The behaviour of text selection and insertion mechanism is similar to	1351	The behaviour of text selection and insertion/pasting mechanism is similar
968	I<xterm>(1).	1352	to I<xterm>(1).
969		1353
970	=over 4	1354	=over 4
971		1355
972	=item B<Selection>:	1356	=item B<Selecting>:
973		1357
974	Left click at the beginning of the region, drag to the end of the region	1358	Left click at the beginning of the region, drag to the end of the region
975	and release; Right click to extend the marked region; Left double-click	1359	and release; Right click to extend the marked region; Left double-click
976	to select a word; Left triple-click to select the entire logical line	1360	to select a word; Left triple-click to select the entire logical line
977	(which can span multiple screen lines), unless modified by resource	1361	(which can span multiple screen lines), unless modified by resource
978	B<tripleclickwords>.	1362	B<tripleclickwords>.
979		1363
980	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1364	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
981	(Compile: I<frills>) will create a rectangular selection instead of a normal	1365	(Compile: I<frills>) will create a rectangular selection instead of a
982	one.	1366	normal one. In this mode, every selected row becomes its own line in the
		1367	selection, and trailing whitespace is visually underlined and removed from
		1368	the selection.
983		1369
984	=item B<Insertion>:	1370	=item B<Pasting>:
985		1371
986	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1372	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
987	an B<@@RXVT_NAME@@> window causes the current text selection to be	1373	window causes the value of the PRIMARY selection (or CLIPBOARD with the
988	inserted as if it had been typed on the keyboard.	1374	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1375
		1376	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1377	inserted too.
989		1378
990	=back	1379	=back
991		1380
992	=head1 CHANGING FONTS	1381	=head1 CHANGING FONTS
993		1382
994	Changing fonts (or font sizes, respectively) via the keypad is not yet	1383	Changing fonts (or font sizes, respectively) via the keypad is not yet
995	supported in rxvt-unicode. Bug me if you need this.	1384	supported in rxvt-unicode. Bug me if you need this.
996		1385
997	You can, however, switch fonts at runtime using escape sequences (and	1386	You can, however, switch fonts at runtime using escape sequences, e.g.:
998	therefore using the menubar), e.g.:
999		1387
1000	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1388	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1389
		1390	You can use keyboard shortcuts, too:
		1391
		1392	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1393	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1001		1394
1002	rxvt-unicode will automatically re-apply these fonts to the output so far.	1395	rxvt-unicode will automatically re-apply these fonts to the output so far.
1003		1396
1004	=head1 ISO 14755 SUPPORT	1397	=head1 ISO 14755 SUPPORT
1005		1398
1006	ISO 14755 is a standard for entering and viewing unicode characters	1399	ISO 14755 is a standard for entering and viewing unicode characters
1007	and character codes using the keyboard. It consists of 4 parts. The	1400	and character codes using the keyboard. It consists of 4 parts. The
1008	first part is available rxvt-unicode has been compiled with	1401	first part is available if rxvt-unicode has been compiled with
1009	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1402	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1010	with C<--enable-iso14755>.	1403	with C<--enable-iso14755>.
1011		1404
1012	=over 4	1405	=over 4
1013		1406
…		…
1033	This mode lets you input characters representing the keycap symbols of	1426	This mode lets you input characters representing the keycap symbols of
1034	your keyboard, if representable in the current locale encoding.	1427	your keyboard, if representable in the current locale encoding.
1035		1428
1036	Start by pressing C<Control> and C<Shift> together, then releasing	1429	Start by pressing C<Control> and C<Shift> together, then releasing
1037	them. The next special key (cursor keys, home etc.) you enter will not	1430	them. The next special key (cursor keys, home etc.) you enter will not
1038	invoke it's usual function but instead will insert the corresponding	1431	invoke its usual function but instead will insert the corresponding
1039	keycap symbol. The symbol will only be entered when the key has been	1432	keycap symbol. The symbol will only be entered when the key has been
1040	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1433	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1041	C<ISO Level 2 Switch>, although your intention might have been to enter a	1434	C<ISO Level 2 Switch>, although your intention might have been to enter a
1042	reverse tab (Shift-Tab).	1435	reverse tab (Shift-Tab).
1043		1436
…		…
1071	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1464	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1072	it can be seen via the I<who(1)> command, and can accept messages. To	1465	it can be seen via the I<who(1)> command, and can accept messages. To
1073	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1466	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1074	on some systems or setgid to root or to some other group on others.	1467	on some systems or setgid to root or to some other group on others.
1075		1468
1076	=head1 COLORS AND GRAPHICS	1469	=head1 COLOURS AND GRAPHICS
1077		1470
1078	In addition to the default foreground and background colours,	1471	In addition to the default foreground and background colours,
1079	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1472	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1080	high-intensity bold/blink versions of the same). Here is a list of the	1473	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1081	colours with their B<rgb.txt> names.	1474	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1475	cube plus a 8 (24) colour greyscale ramp.
		1476
		1477	Here is a list of the ANSI colours with their names.
1082		1478
1083	=begin table	1479	=begin table
1084		1480
1085	B<color0> (black) = Black	1481	B<color0> (black) = Black
1086	B<color1> (red) = Red3	1482	B<color1> (red) = Red3
…		…
1106	It is also possible to specify the colour values of B<foreground>,	1502	It is also possible to specify the colour values of B<foreground>,
1107	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1503	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1108	a number 0-15, as a convenient shorthand to reference the colour name of	1504	a number 0-15, as a convenient shorthand to reference the colour name of
1109	color0-color15.	1505	color0-color15.
1110		1506
		1507	The following text gives values for the standard 88 colour mode (and
		1508	values for the 256 colour mode in parentheses).
		1509
		1510	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1511
		1512	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1513	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1514
		1515	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1516	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1517	the RGB cube.
		1518
		1519	Together, all those colours implement the 88 (256) colour xterm
		1520	colours. Only the first 16 can be changed using resources currently, the
		1521	rest can only be changed via command sequences ("escape codes").
		1522
		1523	Applications are advised to use terminfo or command sequences to discover
		1524	number and RGB values of all colours (yes, you can query this...).
		1525
1111	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1526	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1112	always swapping the foreground/background colours. This is in contrast to	1527	always swapping the foreground/background colours. This is in contrast to
1113	I<xterm>(1) where the colours are only swapped if they have not otherwise	1528	I<xterm>(1) where the colours are only swapped if they have not otherwise
1114	been specified. For example,	1529	been specified. For example,
1115		1530
		1531	@@RXVT_NAME@@ -fg Black -bg White -rv
		1532
		1533	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1534	White.
		1535
		1536	=head2 ALPHA CHANNEL SUPPORT
		1537
		1538	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1539	their act together, rxvt-unicode will do it's own alpha channel management:
		1540
		1541	You can prefix any colour with an opaqueness percentage enclosed in
		1542	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1543	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1544	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1545	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1546	is the recommended format to specify transparency values, and works with
		1547	all ways to specify a colour.
		1548
		1549	For complete control, rxvt-unicode also supports
		1550	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1551	specifications, where the additional C<aaaa> component specifies opacity
		1552	(alpha) values. The minimum value of C<0000> is completely transparent,
		1553	while C<ffff> is completely opaque). The two example colours from
		1554	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1555	C<rgba:0000/ff00/0000/f332>.
		1556
		1557	You probably need to specify B<"-depth 32">, too, to force a visual with
		1558	alpha channels, and have the luck that your X-server uses ARGB pixel
		1559	layout, as X is far from just supporting ARGB visuals out of the box, and
		1560	rxvt-unicode just fudges around.
		1561
		1562	For example, the following selects an almost completely transparent black
		1563	background, and an almost opaque pink foreground:
		1564
		1565	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1566
		1567	When not using a background image, then the interpretation of the
		1568	alpha channel is up to your compositing manager (most interpret it as
		1569	transparency of course).
		1570
		1571	When using a background pixmap or pseudo-transparency, then the background
		1572	colour will always behave as if it were completely transparent (so the
		1573	background image shows instead), regardless of how it was specified, while
		1574	other colours will either be transparent as specified (the background
		1575	image will show through) on servers supporting the RENDER extension, or
		1576	fully opaque on servers not supporting the RENDER EXTENSION.
		1577
		1578	Please note that due to bugs in Xft, specifying alpha values might result
		1579	in garbage being displayed when the X-server does not support the RENDER
		1580	extension.
		1581
		1582	=head1 ENVIRONMENT
		1583
		1584	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1585
1116	=over 4	1586	=over 4
1117		1587
1118	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1119
1120	would yield White on Black, while on I<xterm>(1) it would yield Black
1121	on White.
1122
1123	=back
1124
1125	=head1 ENVIRONMENT
1126
1127	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1128
1129	=over 4
1130
1131	=item B<TERM>	1588	=item B<TERM>
1132		1589
1133	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1590	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1134	resources or on the commandline.	1591	resources or on the command line.
1135		1592
1136	=item B<COLORTERM>	1593	=item B<COLORTERM>
1137		1594
1138	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1595	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1139	compiled with XPM support, and optionally with the added extension	1596	compiled with background image support, and optionally with the added
1140	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1597	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1598	screen.
1141		1599
1142	=item B<COLORFGBG>	1600	=item B<COLORFGBG>
1143		1601
1144	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1602	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1145	the colour code used as default foreground/text colour (or the string	1603	the colour code used as default foreground/text colour (or the string
1146	C<default> to indicate that the default-colour escape sequence is to be	1604	C<default> to indicate that the default-colour escape sequence is to be
1147	used), C<bg> is the colour code used as default background colour (or the	1605	used), C<bg> is the colour code used as default background colour (or the
1148	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1606	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1149	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1607	was compiled with background image support. Libraries like C<ncurses>
1150	(and do) use this information to optimize screen output.	1608	and C<slang> can (and do) use this information to optimize screen output.
1151		1609
1152	=item B<WINDOWID>	1610	=item B<WINDOWID>
1153		1611
1154	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1612	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1155	window, which usually has subwindows for the scrollbar, the terminal	1613	window, which usually has subwindows for the scrollbar, the terminal
…		…
1161	C<--with-terminfo=PATH>.	1619	C<--with-terminfo=PATH>.
1162		1620
1163	=item B<DISPLAY>	1621	=item B<DISPLAY>
1164		1622
1165	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1623	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1166	display in it's child processes.	1624	display in its child processes if C<-display> isn't used to override. It
		1625	defaults to C<:0> if it doesn't exist.
1167		1626
1168	=item B<SHELL>	1627	=item B<SHELL>
1169		1628
1170	The shell to be used for command execution, defaults to C</bin/sh>.	1629	The shell to be used for command execution, defaults to C</bin/sh>.
1171
1172	=item B<RXVTPATH>
1173
1174	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1175	files.
1176
1177	=item B<PATH>
1178
1179	Used in the same way as C<RXVTPATH>.
1180		1630
1181	=item B<RXVT_SOCKET>	1631	=item B<RXVT_SOCKET>
1182		1632
1183	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1633	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1184	@@RXVT_NAME@@d(1).	1634	@@RXVT_NAME@@d(1).
1185		1635
1186	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1636	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1187		1637
1188	=item B<HOME>	1638	=item B<HOME>
1189		1639
1190	Used to locate the default directory for the unix domain socket for	1640	Used to locate the default directory for the unix domain socket for
1191	daemon communications and to locate various resource files (such as	1641	daemon communications and to locate various resource files (such as
1192	C<.Xdefaults>)	1642	C<.Xdefaults>)
1193		1643
1194	=item B<XAPPLRESDIR>	1644	=item B<XAPPLRESDIR>
1195		1645
1196	Directory where various X resource files are being located.	1646	Directory where application-specific X resource files are located.
1197		1647
1198	=item B<XENVIRONMENT>	1648	=item B<XENVIRONMENT>
1199		1649
1200	If set and accessible, gives the name of a X resource file to be loaded by	1650	If set and accessible, gives the name of a X resource file to be loaded by
1201	@@RXVT_NAME@@.	1651	@@RXVT_NAME@@.
…		…
1206		1656
1207	=over 4	1657	=over 4
1208		1658
1209	=item B</usr/lib/X11/rgb.txt>	1659	=item B</usr/lib/X11/rgb.txt>
1210		1660
1211	Color names.	1661	Colour names.
1212		1662
1213	=back	1663	=back
1214		1664
1215	=head1 SEE ALSO	1665	=head1 SEE ALSO
1216		1666
1217	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1667	@@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)
1218
1219	=head1 BUGS
1220
1221	Check the BUGS file for an up-to-date list.
1222
1223	Cursor change support is not yet implemented.
1224
1225	Click-and-drag doesn't work with X11 mouse report overriding.
1226		1668
1227	=head1 CURRENT PROJECT COORDINATOR	1669	=head1 CURRENT PROJECT COORDINATOR
1228		1670
1229	=over 4	1671	=over 4
1230		1672
1231	=item Project Coordinator	1673	=item Project Coordinator
1232		1674
1233	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1675	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1234		1676
1235	L<http://software.schmorp.de/#rxvt-unicode>	1677	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1236		1678
1237	=back	1679	=back
1238		1680
1239	=head1 AUTHORS	1681	=head1 AUTHORS
1240		1682
…		…
1262		1704
1263	Project Coordinator (changes.txt 2.21a to 2.4.5)	1705	Project Coordinator (changes.txt 2.21a to 2.4.5)
1264		1706
1265	=item Geoff Wing L<< <gcw@pobox.com> >>	1707	=item Geoff Wing L<< <gcw@pobox.com> >>
1266		1708
1267	Rewrote screen display and text selection routines. Project Coordinator	1709	Rewrote screen display and text selection routines.
		1710
1268	(changes.txt 2.4.6 - rxvt-unicode)	1711	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1269		1712
1270	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1713	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1271		1714
1272	Forked rxvt-unicode, rewrote most of the display code and internal	1715	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1273	character handling to store text in unicode, improve xterm	1716	extension, random hacks, numerous bugfixes and extensions.
1274	compatibility and apply numerous other bugfixes and extensions.
1275		1717
1276	Project Coordinator (Changes 1.0 -)	1718	Project Coordinator (Changes 1.0 -)
1277		1719
		1720	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1721
		1722	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1723
1278	=back	1724	=back
1279		1725

Diff Legend

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