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

Diff Legend

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