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.98 by root, Mon Jan 16 15:12:48 2006 UTC vs.
Revision 1.251 by root, Sat Jul 3 04:04:12 2021 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
		114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
97		116
98	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
99		118
100	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
101		120
…		…
103		122
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	123	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		124
106	=item B<-j>|B<+j>	125	=item B<-j>|B<+j>
107		126
108	Turn on/off jump scrolling; resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		128
110	=item B<-ip>|B<+ip> | B<-tr>|B<+tr>	129	=item B<-ss>|B<+ss>
111		130
112	Turn on/off inheriting parent window's pixmap. Alternative form is	131	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113	B<-tr>; resource B<inheritPixmap>.
114		132
115	=item B<-fade> I<number>	133	=item B<-fade> I<number>
116		134
117	Fade the text by the given percentage when focus is lost. Small values	135	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	136	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	137	colour; resource B<fading>.
120		138
121	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
122		140
123	Fade to this colour when fading is used (see B<-fade>). The default colour	141	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
125		143
126	=item B<-tint> I<colour>	144	=item B<-icon> I<file>
127		145
128	Tint the transparent background pixmap with the given colour when	146	Compile I<pixbuf>: Use the specified image as application icon. This
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	147	is used by many window managers, taskbars and pagers to represent the
130	non-tiled backgrounds, currently. See also the B<-sh> option that can be	148	application window; resource I<iconFile>.
131	used to brighten or darken the image in addition to tinting it; resource
132	I<tintColor>. Example:
133
134	@@RXVT_NAME@@ -tr -tint blue -sh 40
135
136	=item B<-sh>
137
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
139	background image in addition to tinting it (i.e. B<-tint> must be
140	specified, too, e.g. C<-tint white>).
141		149
142	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
143		151
144	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
145		153
146	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
147		155
148	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
149
150	=item B<-pixmap> I<file[;geom]>
151
152	Compile I<XPM>: Specify XPM file for the background and also optionally
153	specify its scaling with a geometry string. Note you may need to
154	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.
156		157
157	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
158		159
159	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
160		161
…		…
177	that are checked in order when trying to find glyphs for characters. The	178	that are checked in order when trying to find glyphs for characters. The
178	first font defines the cell size for characters; other fonts might be	179	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	180	smaller, but not (in general) larger. A (hopefully) reasonable default
180	font list is always appended to it. See resource B<font> for more details.	181	font list is always appended to it. See resource B<font> for more details.
181		182
182	In short, to specify an X11 core font, just specify it's name or prefix it	183	In short, to specify an X11 core font, just specify its name or prefix it
183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	184	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	185	e.g.:
185		186
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	187	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	188	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
205	italic> >> characters are to be printed. See resource B<boldItalicFont>	206	italic> >> characters are to be printed. See resource B<boldItalicFont>
206	for details.	207	for details.
207		208
208	=item B<-is>|B<+is>	209	=item B<-is>|B<+is>
209		210
210	Compile I<font-styles>: Bold/Italic font styles imply high intensity	211	Compile I<font-styles>: Bold/Blink font styles imply high intensity
211	foreground/background (default). See resource B<intensityStyles> for	212	foreground/background (default). See resource B<intensityStyles> for
212	details.	213	details.
213		214
214	=item B<-name> I<name>	215	=item B<-name> I<name>
215		216
…		…
219		220
220	=item B<-ls>|B<+ls>	221	=item B<-ls>|B<+ls>
221		222
222	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
223		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
224	=item B<-ut>|B<+ut>	229	=item B<-ut>|B<+ut>
225		230
226	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
227	B<utmpInhibit>.	232	B<utmpInhibit>.
228		233
…		…
232	B<visualBell>.	237	B<visualBell>.
233		238
234	=item B<-sb>|B<+sb>	239	=item B<-sb>|B<+sb>
235		240
236	Turn on/off scrollbar; resource B<scrollBar>.	241	Turn on/off scrollbar; resource B<scrollBar>.
		242
		243	=item B<-sr>|B<+sr>
		244
		245	Put scrollbar on right/left; resource B<scrollBar_right>.
		246
		247	=item B<-st>|B<+st>
		248
		249	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		250	resource B<scrollBar_floating>.
237		251
238	=item B<-si>|B<+si>	252	=item B<-si>|B<+si>
239		253
240	Turn on/off scroll-to-bottom on TTY output inhibit; resource	254	Turn on/off scroll-to-bottom on TTY output inhibit; resource
241	B<scrollTtyOutput> has opposite effect.	255	B<scrollTtyOutput> has opposite effect.
…		…
248	=item B<-sw>|B<+sw>	262	=item B<-sw>|B<+sw>
249		263
250	Turn on/off scrolling with the scrollback buffer as new lines appear.	264	Turn on/off scrolling with the scrollback buffer as new lines appear.
251	This only takes effect if B<-si> is also given; resource	265	This only takes effect if B<-si> is also given; resource
252	B<scrollWithBuffer>.	266	B<scrollWithBuffer>.
253
254	=item B<-sr>|B<+sr>
255
256	Put scrollbar on right/left; resource B<scrollBar_right>.
257
258	=item B<-st>|B<+st>
259
260	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
261	resource B<scrollBar_floating>.
262		267
263	=item B<-ptab>|B<+ptab>	268	=item B<-ptab>|B<+ptab>
264		269
265	If enabled (default), "Horizontal Tab" characters are being stored as	270	If enabled (default), "Horizontal Tab" characters are being stored as
266	actual wide characters in the screen buffer, which makes it possible to	271	actual wide characters in the screen buffer, which makes it possible to
…		…
270		275
271	=item B<-bc>|B<+bc>	276	=item B<-bc>|B<+bc>
272		277
273	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
274		279
		280	=item B<-uc>|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
		283
275	=item B<-iconic>	284	=item B<-iconic>
276		285
277	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
278	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
279		288
…		…
295		304
296	=item B<-bl>	305	=item B<-bl>
297		306
298	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299	if honoured by the WM, the rxvt-unicode window will not have window	308	if honoured by the WM, the rxvt-unicode window will not have window
300	decorations; resource B<borderLess>.	309	decorations; resource B<borderLess>. If the window manager does not
		310	support MWM hints (e.g. kwin), enables override-redirect mode.
		311
		312	=item B<-override-redirect>
		313
		314	Compile I<frills>: Sets override-redirect on the window; resource
		315	B<override-redirect>.
		316
		317	=item B<-dockapp>
		318
		319	Sets the initial state of the window to WithdrawnState, which makes
		320	window managers that support this extension treat it as a dockapp.
301		321
302	=item B<-sbg>	322	=item B<-sbg>
303		323
304	Compile I<frills>: Disable the usage of the built-in block graphics/line	324	Compile I<frills>: Disable the usage of the built-in block graphics/line
305	drawing characters and just rely on what the specified fonts provide. Use	325	drawing characters and just rely on what the specified fonts provide. Use
…		…
308		328
309	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
310		330
311	Compile I<frills>: Lines (pixel height) to insert between each row of	331	Compile I<frills>: Lines (pixel height) to insert between each row of
312	the display. Useful to work around font rendering problems; resource	332	the display. Useful to work around font rendering problems; resource
313	B<linespace>.	333	B<lineSpace>.
		334
		335	=item B<-letsp> I<number>
		336
		337	Compile I<frills>: Amount to adjust the computed character width by
		338	to control overall letter spacing. Negative values will tighten up the
		339	letter spacing, positive values will space letters out more. Useful to
		340	work around odd font metrics; resource B<letterSpace>.
314		341
315	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
316		343
317	This option specifies the name of the terminal type to be set in the	344	This option specifies the name of the terminal type to be set in the
318	B<TERM> environment variable. This terminal type must exist in the	345	B<TERM> environment variable. This terminal type must exist in the
…		…
353	=item B<-pt> I<style>	380	=item B<-pt> I<style>
354		381
355	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
356	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
357		384
		385	If the perl extension C<xim-onthespot> is used (which is the default),
		386	then additionally the C<OnTheSpot> preedit type is available.
		387
358	=item B<-im> I<text>	388	=item B<-im> I<text>
359		389
360	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
361		391
362	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
372	for more info.	402	for more info.
373		403
374	=item B<-tcw>	404	=item B<-tcw>
375		405
376	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
		407	button. Only effective when the original (non-perl) selection code is
377	button. Instead of selecting a full line it will extend the selection the	408	in-use. Instead of selecting a full line it will extend the selection to
378	end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
		410
		411	=item B<-dpb>|B<+dpb>
		412
		413	Compile frills: Disables (or enabled) emitting bracketed paste mode
		414	sequences (default enabled). Bracketed paste mode allows programs
		415	to detect when something is pasted. Since more and more programs
		416	abuse this, these sequences can be disabled. The command sequences to
		417	enable and query paste mode will still work, but the actual bracket
		418	sequences will no longer be omitted. You can also toggle this from the
		419	ctrl-middle-mouse-button menu; resource B<disablePAsteBrackets>.
379		420
380	=item B<-insecure>	421	=item B<-insecure>
381		422
382	Enable "insecure" mode, which currently enables most of the escape	423	Enable "insecure" mode, which currently enables most of the escape
383	sequences that echo strings. See the resource B<insecure> for more	424	sequences that echo strings. See the resource B<insecure> for more
…		…
396		437
397	=item B<-ssr>|B<+ssr>	438	=item B<-ssr>|B<+ssr>
398		439
399	Turn on/off secondary screen scroll (default enabled); resource	440	Turn on/off secondary screen scroll (default enabled); resource
400	B<secondaryScroll>.	441	B<secondaryScroll>.
		442
		443	=item B<-rm> I<mode>
		444
		445	Compile I<frills>: Sets long line rewrapping behaviour on window resizes
		446	to one of B<auto> (the default), B<always> or B<never>. The latter two
		447	modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
		448	is non-empty, and wings lines (acts like B<never>) otherwise; resource
		449	B<rewrapMode>.
401		450
402	=item B<-hold>|B<+hold>	451	=item B<-hold>|B<+hold>
403		452
404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	453	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405	will not immediately destroy its window when the program executed within	454	will not immediately destroy its window when the program executed within
406	it exits. Instead, it will wait till it is being killed or closed by the	455	it exits. Instead, it will wait till it is being killed or closed by the
407	user; resource B<hold>.	456	user; resource B<hold>.
408		457
		458	=item B<-cd> I<path>
		459
		460	Sets the working directory for the shell (or the command specified via
		461	B<-e>). The I<path> must be an absolute path and it must exist for
		462	@@RXVT_NAME@@ to start; resource B<chdir>.
		463
		464	=item B<-xrm> I<string>
		465
		466	Works like the X Toolkit option of the same name, by adding the I<string>
		467	as if it were specified in a resource file. Resource values specified this
		468	way take precedence over all other resource specifications.
		469
		470	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		471	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		472	options can be specified as long-options on the commandline, so use
		473	of B<-xrm> is mostly limited to cases where you want to specify other
		474	resources (e.g. for input methods) or for compatibility with other
		475	programs.
		476
409	=item B<-keysym.>I<sym> I<string>	477	=item B<-keysym.>I<sym> I<string>
410		478
411	Remap a key symbol. See resource B<keysym>.	479	Remap a key symbol. See resource B<keysym>.
412		480
413	=item B<-embed> I<windowid>	481	=item B<-embed> I<windowid>
414		482
415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	483	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416	which enables applications to easily embed a terminal.	484	which enables applications to easily embed a terminal.
417		485
418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	486	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	487	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420	quite a bit, so don't expect it to keep some specific state. It's best to	488	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
423	The window will not be destroyed when @@RXVT_NAME@@ exits.	491	The window will not be destroyed when @@RXVT_NAME@@ exits.
424		492
425	It might be useful to know that @@RXVT_NAME@@ will not close file	493	It might be useful to know that @@RXVT_NAME@@ will not close file
426	descriptors passed to it (except for stdin/out/err, of course), so you	494	descriptors passed to it (except for stdin/out/err, of course), so you
427	can use file descriptors to communicate with the programs within the	495	can use file descriptors to communicate with the programs within the
428	terminal. This works regardless of wether the C<-embed> option was used or	496	terminal. This works regardless of whether the C<-embed> option was used or
429	not.	497	not.
430		498
431	Here is a short Gtk2-perl snippet that illustrates how this option can be	499	Here is a short Gtk2-perl snippet that illustrates how this option can be
432	used (a longer example is in F<doc/embed>):	500	used (a longer example is in F<doc/embed>):
433		501
…		…
438	});	506	});
439		507
440	=item B<-pty-fd> I<file descriptor>	508	=item B<-pty-fd> I<file descriptor>
441		509
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	510	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443	pair but instead use the given filehandle as the tty master. This is	511	pair but instead use the given file descriptor as the tty master. This is
444	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	512	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	513	without having to run a program within it.
446		514
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	515	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448	entries and will not tinker with pty/tty permissions - you have to do that	516	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	517	yourself if you want that.
450		518
451	As an extremely special case, specifying C<-1> will completely suppress	519	As an extremely special case, specifying C<-1> will completely suppress
452	pty/tty operations.	520	pty/tty operations, which is probably only useful in conjunction with some
		521	perl extension that manages the terminal.
453		522
454	Here is a example in perl that illustrates how this option can be used (a	523	Here is a example in perl that illustrates how this option can be used (a
455	longer example is in F<doc/pty-fd>):	524	longer example is in F<doc/pty-fd>):
456		525
457	use IO::Pty;	526	use IO::Pty;
…		…
471	Comma-separated list of perl extension scripts to use (or not to use) in	540	Comma-separated list of perl extension scripts to use (or not to use) in
472	this terminal instance. See resource B<perl-ext> for details.	541	this terminal instance. See resource B<perl-ext> for details.
473		542
474	=back	543	=back
475		544
476	=head1 RESOURCES (available also as long-options)	545	=head1 RESOURCES
477		546
478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	547	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479	options) compiled into your version.	548	options) compiled into your version. All resources are also available as
		549	long-options.
480		550
481	You can set and change the resources using X11 tools like B<xrdb>. Many	551	You can set and change the resources using X11 tools like B<xrdb>. Many
482	distribution do also load settings from the B<~/.Xresources> file when X	552	distribution do also load settings from the B<~/.Xresources> file when X
483	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	553	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484	with later settings overwriting earlier ones:	554	with later settings overwriting earlier ones:
485		555
486	1. system-wide app-defaults file, either locale-dependent OR global
487	2. app-defaults file in $XAPPLRESDIR	556	1. app-defaults file in $XAPPLRESDIR
		557	2. $HOME/.Xdefaults
488	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	558	3. RESOURCE_MANAGER property on root-window of screen 0
489	4. SCREEN_RESOURCES for the current screen	559	4. SCREEN_RESOURCES property on root-window of the current screen
490	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	560	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		561	6. resources specified via -xrm on the commandline
491		562
492	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	563	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
493	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	564	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
494	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	565	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
495	configured, while the class name B<URxvt> allows resources unique to	566	configured, while the class name B<URxvt> allows resources unique to
…		…
500	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	571	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501	extensions not documented here):	572	extensions not documented here):
502		573
503	=over 4	574	=over 4
504		575
		576	=item B<depth:> I<bitdepth>
		577
		578	Compile I<xft>: Attempt to find a visual with the given bit depth;
		579	option B<-depth>.
		580
		581	=item B<buffered:> I<boolean>
		582
		583	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		584	On some card/driver combination enabling it slightly decreases
		585	performance, on most it greatly helps it. The slowdown is small, so it
		586	should normally be enabled.
		587
505	=item B<geometry:> I<geom>	588	=item B<geometry:> I<geom>
506		589
507	Create the window with the specified X window geometry [default 80x24];	590	Create the window with the specified X window geometry [default 80x24];
508	option B<-geometry>.	591	option B<-geometry>.
509		592
…		…
522	Use the specified colour for the colour value I<n>, where 0-7	605	Use the specified colour for the colour value I<n>, where 0-7
523	corresponds to low-intensity (normal) colours and 8-15 corresponds to	606	corresponds to low-intensity (normal) colours and 8-15 corresponds to
524	high-intensity (bold = bright foreground, blink = bright background)	607	high-intensity (bold = bright foreground, blink = bright background)
525	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	608	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
526	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	609	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
527	names used are listed in the B<COLORS AND GRAPHICS> section.	610	names used are listed in the B<COLOURS AND GRAPHICS> section.
528		611
529	Colours higher than 15 cannot be set using resources (yet), but can be	612	Colours higher than 15 cannot be set using resources (yet), but can be
530	changed using an escape command (see @@RXVT_NAME@@(7)).	613	changed using an escape command (see @@RXVT_NAME@@(7)).
531		614
532	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	615	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
543	=item B<colorUL:> I<colour>	626	=item B<colorUL:> I<colour>
544		627
545	Use the specified colour to display underlined characters when the	628	Use the specified colour to display underlined characters when the
546	foreground colour is the default.	629	foreground colour is the default.
547		630
548	=item B<colorRV:> I<colour>
549
550	Use the specified colour as the background for reverse video
551	characters.
552
553	=item B<underlineColor:> I<colour>	631	=item B<underlineColor:> I<colour>
554		632
555	If set, use the specified colour as the colour for the underline	633	If set, use the specified colour as the colour for the underline
556	itself. If unset, use the foreground colour.	634	itself. If unset, use the foreground colour.
		635
		636	=item B<highlightColor:> I<colour>
		637
		638	If set, use the specified colour as the background for highlighted
		639	characters. If unset, use reverse video.
		640
		641	=item B<highlightTextColor:> I<colour>
		642
		643	If set and highlightColor is set, use the specified colour as the
		644	foreground for highlighted characters.
557		645
558	=item B<cursorColor:> I<colour>	646	=item B<cursorColor:> I<colour>
559		647
560	Use the specified colour for the cursor. The default is to use the	648	Use the specified colour for the cursor. The default is to use the
561	foreground colour; option B<-cr>.	649	foreground colour; option B<-cr>.
…		…
568		656
569	=item B<reverseVideo:> I<boolean>	657	=item B<reverseVideo:> I<boolean>
570		658
571	B<True>: simulate reverse video by foreground and background colours;	659	B<True>: simulate reverse video by foreground and background colours;
572	option B<-rv>. B<False>: regular screen colours [default]; option	660	option B<-rv>. B<False>: regular screen colours [default]; option
573	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	661	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
574		662
575	=item B<jumpScroll:> I<boolean>	663	=item B<jumpScroll:> I<boolean>
576		664
577	B<True>: specify that jump scrolling should be used. When scrolling	665	B<True>: specify that jump scrolling should be used. When receiving lots
578	quickly, fewer screen updates are performed [default]; option B<-j>.	666	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		667	has been read, resulting in fewer updates while still displaying every
		668	received line; option B<-j>.
		669
579	B<False>: specify that smooth scrolling should be used; option B<+j>.	670	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		671	force a screen refresh on each new line it received; option B<+j>.
580		672
581	=item B<inheritPixmap:> I<boolean>	673	=item B<skipScroll:> I<boolean>
582		674
583	B<True>: make the background inherit the parent windows' pixmap, giving	675	B<True>: (the default) specify that skip scrolling should be used. When
584	artificial transparency. B<False>: do not inherit the parent windows'	676	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
585	pixmap.	677	(around 60 times per second), resulting in far fewer updates. This can
		678	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		679	option B<-ss>.
		680
		681	B<False>: specify that everything is to be displayed, even
		682	if the refresh is too fast for the human eye to read anything (or the
		683	monitor to display anything); option B<+ss>.
586		684
587	=item B<fading:> I<number>	685	=item B<fading:> I<number>
588		686
589	Fade the text by the given percentage when focus is lost; option B<-fade>.	687	Fade the text by the given percentage when focus is lost; option B<-fade>.
590		688
591	=item B<fadeColor:> I<colour>	689	=item B<fadeColor:> I<colour>
592		690
593	Fade to this colour, when fading is used (see B<fading:>). The default	691	Fade to this colour, when fading is used (see B<fading:>). The default
594	colour is black; option B<-fadecolor>.	692	colour is black; option B<-fadecolor>.
595		693
596	=item B<tintColor:> I<colour>	694	=item B<iconFile:> I<file>
597		695
598	Tint the transparent background pixmap with the given colour; option	696	Set the application icon pixmap; option B<-icon>.
599	B<-tint>.
600
601	=item B<shading:> I<number>
602
603	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
604	image in addition to tinting it.
605		697
606	=item B<scrollColor:> I<colour>	698	=item B<scrollColor:> I<colour>
607		699
608	Use the specified colour for the scrollbar [default #B2B2B2].	700	Use the specified colour for the scrollbar [default #B2B2B2].
609		701
…		…
614		706
615	=item B<borderColor:> I<colour>	707	=item B<borderColor:> I<colour>
616		708
617	The colour of the border around the text area and between the scrollbar	709	The colour of the border around the text area and between the scrollbar
618	and the text.	710	and the text.
619
620	=item B<backgroundPixmap:> I<file[;geom]>
621
622	Use the specified XPM file (note the `.xpm' extension is optional) for
623	the background and also optionally specify its scaling with a geometry
624	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
625	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
626	centre (percent). A scale of 0 displays the image with tiling. A scale
627	of 1 displays the image without any scaling. A scale of 2 to 9
628	specifies an integer number of images in that direction. No image will
629	be magnified beyond 10 times its original size. The maximum permitted
630	scale is 1000. [default 0x0+50+50]
631
632	=item B<path:> I<path>
633
634	Specify the colon-delimited search path for finding XPM files.
635		711
636	=item B<font:> I<fontlist>	712	=item B<font:> I<fontlist>
637		713
638	Select the fonts to be used. This is a comma separated list of font names	714	Select the fonts to be used. This is a comma separated list of font names
639	that are checked in order when trying to find glyphs for characters. The	715	that are checked in order when trying to find glyphs for characters. The
…		…
662	it is named first) and thus defines the character cell grid to be 9 pixels	738	it is named first) and thus defines the character cell grid to be 9 pixels
663	wide and 15 pixels high.	739	wide and 15 pixels high.
664		740
665	The second font is just used to add additional unicode characters not in	741	The second font is just used to add additional unicode characters not in
666	the base font, likewise the third, which is unfortunately non-bold, but	742	the base font, likewise the third, which is unfortunately non-bold, but
667	the bold version of the font does contain less characters, so this is a	743	the bold version of the font does contain fewer characters, so this is a
668	useful supplement.	744	useful supplement.
669		745
670	The third font is an Xft font with aliasing turned off, and the characters	746	The third font is an Xft font with aliasing turned off, and the characters
671	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	747	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
672	contains other characters, but we are not interested in them.	748	contains other characters, but we are not interested in them.
…		…
696	text font will being used for the given style.	772	text font will being used for the given style.
697		773
698	=item B<intensityStyles:> I<boolean>	774	=item B<intensityStyles:> I<boolean>
699		775
700	When font styles are not enabled, or this option is enabled (B<True>,	776	When font styles are not enabled, or this option is enabled (B<True>,
701	option B<-is>, the default), bold and italic font styles imply high	777	option B<-is>, the default), bold/blink font styles imply high
702	intensity foreground/backround colours. Disabling this option (B<False>,	778	intensity foreground/background colours. Disabling this option (B<False>,
703	option B<+is>) disables this behaviour, the high intensity colours are not	779	option B<+is>) disables this behaviour, the high intensity colours are not
704	reachable.	780	reachable.
705
706	=item B<selectstyle:> I<mode>
707
708	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
709	xterm style with 2.20 old word selection, or anything else which gives
710	xterm style selection.
711
712	=item B<scrollstyle:> I<mode>
713
714	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
715	the author's favourite.
716		781
717	=item B<title:> I<string>	782	=item B<title:> I<string>
718		783
719	Set window title string, the default title is the command-line	784	Set window title string, the default title is the command-line
720	specified after the B<-e> option, if any, otherwise the application	785	specified after the B<-e> option, if any, otherwise the application
…		…
729	=item B<mapAlert:> I<boolean>	794	=item B<mapAlert:> I<boolean>
730		795
731	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	796	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
732	de-iconify (map) on receipt of a bell character [default].	797	de-iconify (map) on receipt of a bell character [default].
733		798
		799	=item B<urgentOnBell:> I<boolean>
		800
		801	B<True>: set the urgency hint for the wm on receipt of a bell character.
		802	B<False>: do not set the urgency hint [default].
		803
		804	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		805
734	=item B<visualBell:> I<boolean>	806	=item B<visualBell:> I<boolean>
735		807
736	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	808	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
737	B<False>: no visual bell [default]; option B<+vb>.	809	B<False>: no visual bell [default]; option B<+vb>.
738		810
…		…
740		812
741	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	813	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
742	the shell; option B<-ls>. B<False>: start as a normal sub-shell	814	the shell; option B<-ls>. B<False>: start as a normal sub-shell
743	[default]; option B<+ls>.	815	[default]; option B<+ls>.
744		816
		817	=item B<multiClickTime:> I<number>
		818
		819	Specify the maximum time in milliseconds between multi-click select
		820	events. The default is 500 milliseconds; option B<-mc>.
		821
745	=item B<utmpInhibit:> I<boolean>	822	=item B<utmpInhibit:> I<boolean>
746		823
747	B<True>: inhibit writing record into the system log file B<utmp>;	824	B<True>: inhibit writing record into the system log file B<utmp>;
748	option B<-ut>. B<False>: write record into the system log file B<utmp>	825	option B<-ut>. B<False>: write record into the system log file B<utmp>
749	[default]; option B<+ut>.	826	[default]; option B<+ut>.
…		…
759	Example:	836	Example:
760		837
761	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	838	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762		839
763	This creates a new file in your home directory with the screen contents	840	This creates a new file in your home directory with the screen contents
764	everytime you hit C<Print>.	841	every time you hit C<Print>.
		842
		843	=item B<scrollstyle:> I<mode>
		844
		845	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		846	the author's favourite.
		847
		848	=item B<thickness:> I<number>
		849
		850	Set the scrollbar width in pixels.
765		851
766	=item B<scrollBar:> I<boolean>	852	=item B<scrollBar:> I<boolean>
767		853
768	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	854	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
769	disable the scrollbar; option B<+sb>.	855	disable the scrollbar; option B<+sb>.
…		…
789	B<False>: do not scroll to bottom when tty receives output; option	875	B<False>: do not scroll to bottom when tty receives output; option
790	B<+si>.	876	B<+si>.
791		877
792	=item B<scrollWithBuffer:> I<boolean>	878	=item B<scrollWithBuffer:> I<boolean>
793		879
794	B<True>: scroll with scrollback buffer when tty receives new lines (and	880	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
795	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	881	try to show the same lines) and B<scrollTtyOutput> is False; option
796	with scrollback buffer when tty recieves new lines; option B<+sw>.	882	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		883	new lines; option B<+sw>.
797		884
798	=item B<scrollTtyKeypress:> I<boolean>	885	=item B<scrollTtyKeypress:> I<boolean>
799		886
800	B<True>: scroll to bottom when a non-special key is pressed. Special keys	887	B<True>: scroll to bottom when a non-special key is pressed. Special keys
801	are those which are intercepted by rxvt-unicode for special handling and	888	are those which are intercepted by rxvt-unicode for special handling and
802	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	889	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
803	bottom when a non-special key is pressed; option B<+sk>.	890	bottom when a non-special key is pressed; option B<+sk>.
804		891
805	=item B<saveLines:> I<number>	892	=item B<saveLines:> I<number>
806		893
807	Save I<number> lines in the scrollback buffer [default 64]. This	894	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
808	resource is limited on most machines to 65535; option B<-sl>.
809		895
810	=item B<internalBorder:> I<number>	896	=item B<internalBorder:> I<number>
811		897
812	Internal border of I<number> pixels. This resource is limited to 100;	898	Internal border of I<number> pixels. This resource is limited to 100;
813	option B<-b>.	899	option B<-b>.
…		…
832	=item B<termName:> I<termname>	918	=item B<termName:> I<termname>
833		919
834	Specifies the terminal type name to be set in the B<TERM> environment	920	Specifies the terminal type name to be set in the B<TERM> environment
835	variable; option B<-tn>.	921	variable; option B<-tn>.
836		922
837	=item B<linespace:> I<number>	923	=item B<lineSpace:> I<number>
838		924
839	Specifies number of lines (pixel height) to insert between each row of	925	Specifies number of lines (pixel height) to insert between each row of
840	the display [default 0]; option B<-lsp>.	926	the display [default 0]; option B<-lsp>.
841		927
842	=item B<meta8:> I<boolean>	928	=item B<meta8:> I<boolean>
…		…
856		942
857	=item B<cursorBlink:> I<boolean>	943	=item B<cursorBlink:> I<boolean>
858		944
859	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	945	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
860	option B<-bc>.	946	option B<-bc>.
		947
		948	=item B<cursorUnderline:> I<boolean>
		949
		950	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		951	option B<-uc>.
861		952
862	=item B<pointerBlank:> I<boolean>	953	=item B<pointerBlank:> I<boolean>
863		954
864	B<True>: blank the pointer when a key is pressed or after a set number	955	B<True>: blank the pointer when a key is pressed or after a set number
865	of seconds of inactivity. B<False>: the pointer is always visible	956	of seconds of inactivity. B<False>: the pointer is always visible
…		…
871		962
872	=item B<pointerColor2:> I<colour>	963	=item B<pointerColor2:> I<colour>
873		964
874	Mouse pointer background colour.	965	Mouse pointer background colour.
875		966
		967	=item B<pointerShape:> I<string>
		968
		969	Compile I<frills>: Specifies the name of the mouse pointer shape
		970	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		971	file for possible values (omit the C<XC_> prefix).
		972
876	=item B<pointerBlankDelay:> I<number>	973	=item B<pointerBlankDelay:> I<number>
877		974
878	Specifies number of seconds before blanking the pointer [default 2]. Use a	975	Specifies number of seconds before blanking the pointer [default 2]. Use a
879	large number (e.g. C<987654321>) to effectively disable the timeout.	976	large number (e.g. C<987654321>) to effectively disable the timeout.
880		977
881	=item B<backspacekey:> I<string>	978	=item B<backspacekey:> I<string>
882		979
883	The string to send when the backspace key is pressed. If set to B<DEC>	980	The string to send when the backspace key is pressed. If set to B<DEC>
884	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	981	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
885	(code 8) - which can be reversed with the appropriate DEC private mode	982	(code 8) - which can be reversed with the appropriate DEC private mode
886	escape sequence.	983	escape sequence.
887		984
888	=item B<deletekey:> I<string>	985	=item B<deletekey:> I<string>
889		986
…		…
891	pressed. If unset it will send the sequence traditionally associated	988	pressed. If unset it will send the sequence traditionally associated
892	with the B<Execute> key.	989	with the B<Execute> key.
893		990
894	=item B<cutchars:> I<string>	991	=item B<cutchars:> I<string>
895		992
896	The characters used as delimiters for double-click word selection. The	993	The characters used as delimiters for double-click word selection
897	built-in default:	994	(whitespace delimiting is added automatically if resource is given).
898		995
		996	When the perl selection extension is in use (the default if compiled
		997	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		998	characters will be created (if the resource exists, otherwise, no regex
		999	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1000
		1001	When the selection extension is not used, only ISO-8859-1 characters can
		1002	be used. If not specified, the built-in default is used:
		1003
899	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1004	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
900		1005
901	=item B<preeditType:> I<style>	1006	=item B<preeditType:> I<style>
902		1007
903	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1008	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
904		1009
905	=item B<inputMethod:> I<name>	1010	=item B<inputMethod:> I<name>
906		1011
907	I<name> of inputMethod to use; option B<-im>.	1012	I<name> of inputMethod to use; option B<-im>.
908		1013
…		…
925	=item B<tripleclickwords:> I<boolean>	1030	=item B<tripleclickwords:> I<boolean>
926		1031
927	Change the meaning of triple-click selection with the left mouse	1032	Change the meaning of triple-click selection with the left mouse
928	button. Instead of selecting a full line it will extend the selection to	1033	button. Instead of selecting a full line it will extend the selection to
929	the end of the logical line only; option B<-tcw>.	1034	the end of the logical line only; option B<-tcw>.
		1035
		1036	=item B<disablePasteBrackets:> I<boolean>
		1037
		1038	Prevents emission of paste bracket sequences; option B<-dpb>.
930		1039
931	=item B<insecure:> I<boolean>	1040	=item B<insecure:> I<boolean>
932		1041
933	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1042	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
934	echo arbitrary strings like the icon name or the locale. This could be	1043	echo arbitrary strings like the icon name or the locale. This could be
…		…
952		1061
953	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1062	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
954	character is passed through. It may contain escape values as described	1063	character is passed through. It may contain escape values as described
955	in the entry on B<keysym> following.	1064	in the entry on B<keysym> following.
956		1065
957	=item B<secondaryScreen:> I<bool>	1066	=item B<secondaryScreen:> I<boolean>
958		1067
959	Turn on/off secondary screen (default enabled).	1068	Turn on/off secondary screen (default enabled).
960		1069
		1070	=item B<rewrapMode:> I<mode>
		1071
		1072	Sets long line rewrap behaviour on window resize to one of B<auto>
		1073	(default), B<always> or B<never>.
		1074
961	=item B<secondaryScroll:> I<bool>	1075	=item B<secondaryScroll:> I<boolean>
962		1076
963	Turn on/off secondary screen scroll (default enabled). If the this	1077	Turn on/off secondary screen scroll (default enabled). If this
964	option is enabled, scrolls on the secondary screen will change the	1078	option is enabled, scrolls on the secondary screen will change the
965	scrollback buffer and switching to/from the secondary screen will	1079	scrollback buffer and, when secondaryScreen is off, switching
966	instead scroll the screen up.	1080	to/from the secondary screen will instead scroll the screen up.
967		1081
968	=item B<hold>: I<bool>	1082	=item B<hold>: I<boolean>
969		1083
970	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1084	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
971	will not immediately destroy its window when the program executed within	1085	will not immediately destroy its window when the program executed within
972	it exits. Instead, it will wait till it is being killed or closed by the	1086	it exits. Instead, it will wait till it is being killed or closed by the
973	user.	1087	user.
974		1088
		1089	=item B<chdir>: I<path>
		1090
		1091	Sets the working directory for the shell (or the command specified via
		1092	B<-e>). The I<path> must be an absolute path and it must exist for
		1093	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1094	directory will be used; option B<-cd>.
		1095
975	=item B<keysym.>I<sym>: I<string>	1096	=item B<keysym.>I<sym>: I<action>
976		1097
977	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1098	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
978	intervening resource name B<keysym.> cannot be omitted.	1099	resource name B<keysym.> cannot be omitted.
979		1100
980	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1101	Using this resource, you can map key combinations such as
981	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1102	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
982	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1103	string than would normally result from that combination, making the
983	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1104	terminal scroll up or down the way you want it, or any other thing an
984	B<2>, B<3>, B<4>, B<5>.	1105	extension might provide.
		1106
		1107	The key combination that triggers the action, I<sym>, has the following format:
		1108
		1109	(modifiers-)key
		1110
		1111	Where I<modifiers> can be any combination of the following full or
		1112	abbreviated modifier names:
		1113
		1114	=begin table
		1115
		1116	B<ISOLevel3> B<I>
		1117	B<AppKeypad> B<K>
		1118	B<Control> B<C>
		1119	B<NumLock> B<N>
		1120	B<Shift> B<S>
		1121	B<Meta> B<M> I<or> B<A>
		1122	B<Lock> B<L>
		1123	B<Mod1> B<1>
		1124	B<Mod2> B<2>
		1125	B<Mod3> B<3>
		1126	B<Mod4> B<4>
		1127	B<Mod5> B<5>
		1128
		1129	=end table
985		1130
986	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1131	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
987	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1132	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
988	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1133	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
989	current application keymap mode state.	1134	current application keymap mode state.
990		1135
991	The spellings of I<key> can be obtained by using B<xev>(1) command or	1136	Due the the large number of modifier combinations, a key mapping will
992	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1137	match if I<at least> the specified identifiers are being set, and no other
		1138	key mappings with those and more bits are being defined. That means that
		1139	defining a mapping for C<a> will automatically provide definitions for
		1140	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1141	themselves. See the C<builtin:> action, below, for a way to work around
		1142	this when this is a problem.
		1143
		1144	The spelling of I<key> depends on your implementation of X. An easy way to
		1145	find a key name is to use the B<xev>(1) command. You can find a list by
		1146	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
993	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1147	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
994	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1148	value (B<0x0000 - 0xFFFF>).
995	performed in an exact manner; however, the closest match is assured.
996		1149
997	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1150	As with any resource value, the I<action> string may contain backslash
998	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1151	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
999	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1152	number), see RESOURCES in C<man 7 X> for further details.
1000	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1001	can start or end with whitespace.
1002		1153
1003	Please note that you need to double the C<\> in resource files, as	1154	An action starts with an action prefix that selects a certain type
1004	Xlib itself does it's own de-escaping (you can use C<\033> instead of	1155	of action, followed by a colon. An action string without colons is
1005	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own	1156	interpreted as a literal string to pass to the tty (as if it was
1006	processing).	1157	prefixed with C<string:>).
1007		1158
1008	You can define a range of keysyms in one shot by providing a I<string>	1159	The following action prefixes are known - extensions can provide
1009	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1160	additional prefixes:
		1161
		1162	=over 4
		1163
		1164	=item string:STRING
		1165
		1166	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1167	then the remaining C<STRING> will be passed to the program running in the
		1168	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1169	string C<echo rm -rf /> followed by a newline:
		1170
		1171	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1172
		1173	This could in theory be used to completely redefine your keymap.
		1174
		1175	In addition, for actions of this type, you can define a range of
		1176	keysyms in one shot by loading the C<keysym-list> perl extension and
		1177	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1010	should be a character not used by the strings.	1178	the delimiter `/' should be a character not used by the strings.
1011		1179
1012	Its usage can be demonstrated by an example:	1180	Its usage can be demonstrated by an example:
1013		1181
1014	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>	1182	URxvt.keysym.M-C-0x61: list|\033<|abc|>
1015		1183
1016	The above line is equivalent to the following three lines:	1184	The above line is equivalent to the following three lines:
1017		1185
1018	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1186	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1019	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1187	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1020	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1188	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1021		1189
		1190	=item command:STRING
		1191
1022	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1192	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1023	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1193	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1194	the opposite of C<string:> - instead of sending it to the program running
		1195	in the terminal, it will be treated as if it were program output). This is
		1196	most useful to feed command sequences into @@RXVT_NAME@@.
		1197
1024	example the following means "change the current locale to C<zh_CN.GBK>	1198	For example the following means "change the current locale to C<zh_CN.GBK>
1025	when Control-Meta-c is being pressed":	1199	when Control-Meta-c is being pressed":
1026		1200
1027	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1201	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1028		1202
1029	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1203	The following example will map Control-Meta-1 and Control-Meta-2 to
1030	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1204	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1031	manpage. For example, the F<selection> extension (activated via	1205	font-switching at runtime:
1032	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1033		1206
1034	URxvt.keysym.M-C-c: perl:selection:rot13	1207	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1208	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1035		1209
1036	Due the the large number of modifier combinations, a defined key mapping	1210	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1037	will match if at I<at least> the specified identifiers are being set, and	1211	info):
1038	no other key mappings with those and more bits are being defined. That
1039	means that defining a key map for C<a> will automatically provide
1040	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1041	mappings themselves.
1042		1212
1043	Unfortunately, this will override built-in key mappings. For example	1213	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1214	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1215
		1216	=item builtin:
		1217
		1218	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1219	key binding existed for the key combination. The obvious use is to undo
		1220	the effect of existing bindings. The not so obvious use is to reinstate
		1221	bindings when another binding overrides too many modifiers.
		1222
1044	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1223	For example if you overwrite the C<Insert> key you will disable
1045	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1224	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1046	user-defined keymap using the C<builtin:> replacement:	1225	"holes" into the user-defined keymap using the C<builtin:> replacement:
1047		1226
1048	URxvt.keysym.Insert: <my insert key sequence>	1227	URxvt.keysym.Insert: <my insert key sequence>
1049	URxvt.keysym.S-Insert: builtin:	1228	URxvt.keysym.S-Insert: builtin:
1050		1229
1051	The first line defines a mapping for C<Insert> and I<any> combination	1230	The first line defines a mapping for C<Insert> and I<any> combination
1052	of modifiers. The second line re-establishes the default mapping for	1231	of modifiers. The second line re-establishes the default mapping for
1053	C<Shift-Insert>.	1232	C<Shift-Insert>.
1054		1233
1055	The following example will map Control-Meta-1 and Control-Meta-2 to	1234	=item builtin-string:
1056	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1057	font-switching at runtime:
1058		1235
1059	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1236	This action is mainly useful to restore string mappings for keys that
1060	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1237	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1238	difficult to explain - basically, this action will send the string to the
		1239	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1240	action for it.
1061		1241
1062	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1242	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1063	info):	1243	selection when you press C<Shift-Insert>. With the following bindings, it
		1244	would instead emit the (undocumented, but what applications running in the
		1245	terminal might expect) sequence C<ESC [ 2 $> instead:
1064		1246
1065	URxvt.keysym.M-C-3: command:\033[8;25;80t	1247	URxvt.keysym.S-Insert: builtin-string:
1066	URxvt.keysym.M-C-4: command:\033[8;48;110t	1248	URxvt.keysym.C-S-Insert: builtin:
		1249
		1250	The first line disables the paste functionality for that key
		1251	combination, and the second reinstates the default behaviour for
		1252	C<Control-Shift-Insert>, which would otherwise be overridden.
		1253
		1254	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1255	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1256	this:
		1257
		1258	URxvt.keysym.C-M-c: builtin-string:
		1259	URxvt.keysym.C-M-v: builtin-string:
		1260
		1261	=item EXTENSION:STRING
		1262
		1263	An action of this form invokes the action B<STRING>, if any, provided
		1264	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1265	be loaded automatically if necessary.
		1266
		1267	Not all extensions define actions, but popular extensions that do
		1268	include the I<selection> and I<matcher> extensions (documented in their
		1269	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1270	respectively).
		1271
		1272	From the silly examples department, this will rot13-"encrypt"
		1273	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1274	keyboards:
		1275
		1276	URxvt.keysym.M-C-c: selection:rot13
		1277
		1278	=item perl:STRING *DEPRECATED*
		1279
		1280	This is a deprecated way of invoking commands provided by perl
		1281	extensions. It is still supported, but should not be used anymore.
		1282
		1283	=back
1067		1284
1068	=item B<perl-ext-common>: I<string>	1285	=item B<perl-ext-common>: I<string>
1069		1286
1070	=item B<perl-ext>: I<string>	1287	=item B<perl-ext>: I<string>
1071		1288
…		…
1073	use in this terminal instance; option B<-pe>.	1290	use in this terminal instance; option B<-pe>.
1074		1291
1075	Extension names can be prefixed with a C<-> sign to prohibit using	1292	Extension names can be prefixed with a C<-> sign to prohibit using
1076	them. This can be useful to selectively disable some extensions loaded	1293	them. This can be useful to selectively disable some extensions loaded
1077	by default, or specified via the C<perl-ext-common> resource. For	1294	by default, or specified via the C<perl-ext-common> resource. For
1078	example, C<default,-selection> will use all the default extension except	1295	example, C<default,-selection> will use all the default extensions except
1079	C<selection>.	1296	C<selection>.
1080		1297
1081	Extension names can also be followed by an argument in angle brackets	1298	The default set includes the C<selection>, C<option-popup>,
1082	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1299	C<selection-popup>, C<readline> and C<searchable-scrollback>
1083	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1300	extensions, and extensions which are mentioned in B<keysym> resources.
1084	multiple times with different arguments will pass multiple arguments to	1301
1085	the extension.	1302	Any extension such that a corresponding resource is given on the
		1303	command line is automatically appended to B<perl-ext>.
1086		1304
1087	Each extension is looked up in the library directories, loaded if	1305	Each extension is looked up in the library directories, loaded if
1088	necessary, and bound to the current terminal instance.	1306	necessary, and bound to the current terminal instance. When the library
		1307	search path contains multiple extension files of the same name, then the
		1308	first one found will be used.
1089		1309
1090	If both of these resources are the empty string, then the perl	1310	If both of these resources are the empty string, then the perl interpreter
1091	interpreter will not be initialized. The idea behind two options is that	1311	will not be initialized. The rationale for having two options is that
1092	B<perl-ext-common> will be used for extensions that should be available to	1312	B<perl-ext-common> will be used for extensions that should be available to
1093	all instances, while B<perl-ext> is used for specific instances.	1313	all instances, while B<perl-ext> is used for specific instances.
1094		1314
1095	=item B<perl-eval>: I<string>	1315	=item B<perl-eval>: I<string>
1096		1316
1097	Perl code to be evaluated when all extensions have been registered. See	1317	Perl code to be evaluated when all extensions have been registered. See
1098	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1318	the @@RXVT_NAME@@perl(3) manpage.
1099	will be ignored when running setuid/setgid.
1100		1319
1101	=item B<perl-lib>: I<path>	1320	=item B<perl-lib>: I<path>
1102		1321
1103	Colon-separated list of additional directories that hold extension	1322	Colon-separated list of additional directories that hold extension
1104	scripts. When looking for extensions specified by the C<perl> resource,	1323	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1105	@@RXVT_NAME@@ will first look in these directories and then in	1324	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1106	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1325	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1107	will be ignored when running setuid/setgid.
1108		1326
1109	See the @@RXVT_NAME@@perl(3) manpage.	1327	See the @@RXVT_NAME@@perl(3) manpage.
1110		1328
1111	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1329	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1112		1330
…		…
1116	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1334	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1117		1335
1118	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1336	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1119	for details.	1337	for details.
1120		1338
1121	=item B<searchable-scrollback:> I<keysym>	1339	=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1122		1340
1123	Sets the hotkey that starts the incremental scrollback buffer search	1341	This resource is deprecated and will be removed. Use a B<keysym> resource
1124	(default: C<M-s>).	1342	instead, e.g.:
1125		1343
		1344	URxvt.keysym.M-s: searchable-scrollback:start
		1345
1126	=item B<urlLauncher>: I<string>	1346	=item B<url-launcher>: I<string>
1127		1347
1128	Specifies the program to be started with a URL argument. Used by the	1348	Specifies the program to be started with a URL argument. Used by the
1129	C<selection-popup> and C<mark-urls> perl extensions.	1349	C<selection-popup> and C<matcher> perl extensions.
1130		1350
1131	=item B<transient-for>: I<windowid>	1351	=item B<transient-for>: I<windowid>
1132		1352
1133	Sets the WM_TRANSIENT_FOR property to the given window iw.	1353	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1354
		1355	=item B<override-redirect>: I<boolean>
		1356
		1357	Compile I<frills>: Sets override-redirect for the terminal window, making
		1358	it almost invisible to window managers; option B<-override-redirect>.
		1359
		1360	=item B<iso14755:> I<boolean>
		1361
		1362	Turn on/off ISO 14755 (default enabled).
		1363
		1364	=item B<iso14755_52:> I<boolean>
		1365
		1366	Turn on/off ISO 14755 5.2 mode (default enabled).
1134		1367
1135	=back	1368	=back
1136		1369
1137	=head1 THE SCROLLBAR	1370	=head1 THE SCROLLBAR
1138		1371
…		…
1157	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1390	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1158	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1391	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1159	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1392	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1160	respectively.	1393	respectively.
1161		1394
1162	=head1 TEXT SELECTION AND INSERTION	1395	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1163		1396
1164	The behaviour of text selection and insertion mechanism is similar to	1397	The behaviour of text selection and insertion/pasting mechanism is similar
1165	I<xterm>(1).	1398	to I<xterm>(1).
1166		1399
1167	=over 4	1400	=over 4
1168		1401
1169	=item B<Selection>:	1402	=item B<Selecting>:
1170		1403
1171	Left click at the beginning of the region, drag to the end of the region	1404	Left click at the beginning of the region, drag to the end of the region
1172	and release; Right click to extend the marked region; Left double-click	1405	and release; Right click to extend the marked region; Left double-click
1173	to select a word; Left triple-click to select the entire logical line	1406	to select a word; Left triple-click to select the entire logical line
1174	(which can span multiple screen lines), unless modified by resource	1407	(which can span multiple screen lines), unless modified by resource
…		…
1178	(Compile: I<frills>) will create a rectangular selection instead of a	1411	(Compile: I<frills>) will create a rectangular selection instead of a
1179	normal one. In this mode, every selected row becomes its own line in the	1412	normal one. In this mode, every selected row becomes its own line in the
1180	selection, and trailing whitespace is visually underlined and removed from	1413	selection, and trailing whitespace is visually underlined and removed from
1181	the selection.	1414	the selection.
1182		1415
1183	=item B<Insertion>:	1416	=item B<Pasting>:
1184		1417
1185	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1418	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1186	an B<@@RXVT_NAME@@> window causes the current text selection to be	1419	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1187	inserted as if it had been typed on the keyboard.	1420	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1421
		1422	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1423	inserted too.
		1424
		1425	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1426	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1427	binding causes the value of the internal selection to be copied to the
		1428	CLIPBOARD selection, while the second binding causes the value of the
		1429	CLIPBOARD selection to be inserted.
1188		1430
1189	=back	1431	=back
1190		1432
1191	=head1 CHANGING FONTS	1433	=head1 CHANGING FONTS
1192		1434
…		…
1206		1448
1207	=head1 ISO 14755 SUPPORT	1449	=head1 ISO 14755 SUPPORT
1208		1450
1209	ISO 14755 is a standard for entering and viewing unicode characters	1451	ISO 14755 is a standard for entering and viewing unicode characters
1210	and character codes using the keyboard. It consists of 4 parts. The	1452	and character codes using the keyboard. It consists of 4 parts. The
1211	first part is available rxvt-unicode has been compiled with	1453	first part is available if rxvt-unicode has been compiled with
1212	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1454	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1213	with C<--enable-iso14755>.	1455	with C<--enable-iso14755>.
1214		1456
1215	=over 4	1457	=over 4
1216		1458
…		…
1236	This mode lets you input characters representing the keycap symbols of	1478	This mode lets you input characters representing the keycap symbols of
1237	your keyboard, if representable in the current locale encoding.	1479	your keyboard, if representable in the current locale encoding.
1238		1480
1239	Start by pressing C<Control> and C<Shift> together, then releasing	1481	Start by pressing C<Control> and C<Shift> together, then releasing
1240	them. The next special key (cursor keys, home etc.) you enter will not	1482	them. The next special key (cursor keys, home etc.) you enter will not
1241	invoke it's usual function but instead will insert the corresponding	1483	invoke its usual function but instead will insert the corresponding
1242	keycap symbol. The symbol will only be entered when the key has been	1484	keycap symbol. The symbol will only be entered when the key has been
1243	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1485	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1244	C<ISO Level 2 Switch>, although your intention might have been to enter a	1486	C<ISO Level 2 Switch>, although your intention might have been to enter a
1245	reverse tab (Shift-Tab).	1487	reverse tab (Shift-Tab).
1246		1488
…		…
1274	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1516	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1275	it can be seen via the I<who(1)> command, and can accept messages. To	1517	it can be seen via the I<who(1)> command, and can accept messages. To
1276	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1518	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1277	on some systems or setgid to root or to some other group on others.	1519	on some systems or setgid to root or to some other group on others.
1278		1520
1279	=head1 COLORS AND GRAPHICS	1521	=head1 COLOURS AND GRAPHICS
1280		1522
1281	In addition to the default foreground and background colours,	1523	In addition to the default foreground and background colours,
1282	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1524	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1283	high-intensity bold/blink versions of the same). Here is a list of the	1525	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1284	colours with their B<rgb.txt> names.	1526	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1527	cube plus a 8 (24) colour greyscale ramp.
		1528
		1529	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1530	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1531	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1532	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1533	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1534	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1535	use many similar 24-bit colours. It's typically not a problem in common
		1536	scenarios.
		1537
		1538	Here is a list of the ANSI colours with their names.
1285		1539
1286	=begin table	1540	=begin table
1287		1541
1288	B<color0> (black) = Black	1542	B<color0> (black) = Black
1289	B<color1> (red) = Red3	1543	B<color1> (red) = Red3
…		…
1309	It is also possible to specify the colour values of B<foreground>,	1563	It is also possible to specify the colour values of B<foreground>,
1310	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1564	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1311	a number 0-15, as a convenient shorthand to reference the colour name of	1565	a number 0-15, as a convenient shorthand to reference the colour name of
1312	color0-color15.	1566	color0-color15.
1313		1567
		1568	The following text gives values for the standard 88 colour mode (and
		1569	values for the 256 colour mode in parentheses).
		1570
		1571	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1572
		1573	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1574	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1575
		1576	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1577	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1578	the RGB cube.
		1579
		1580	Together, all those colours implement the 88 (256) colour xterm
		1581	colours. Only the first 16 can be changed using resources currently, the
		1582	rest can only be changed via command sequences ("escape codes").
		1583
		1584	Applications are advised to use terminfo or command sequences to discover
		1585	number and RGB values of all colours (yes, you can query this...).
		1586
1314	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1587	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1315	always swapping the foreground/background colours. This is in contrast to	1588	always swapping the foreground/background colours. This is in contrast to
1316	I<xterm>(1) where the colours are only swapped if they have not otherwise	1589	I<xterm>(1) where the colours are only swapped if they have not otherwise
1317	been specified. For example,	1590	been specified. For example,
1318		1591
		1592	@@RXVT_NAME@@ -fg Black -bg White -rv
		1593
		1594	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1595	White.
		1596
		1597	=head2 ALPHA CHANNEL SUPPORT
		1598
		1599	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1600	their act together, rxvt-unicode will do its own alpha channel management:
		1601
		1602	You can prefix any colour with an opaqueness percentage enclosed in
		1603	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1604	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1605	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1606	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1607	is the recommended format to specify transparency values, and works with
		1608	all ways to specify a colour.
		1609
		1610	For complete control, rxvt-unicode also supports
		1611	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1612	specifications, where the additional C<aaaa> component specifies opacity
		1613	(alpha) values. The minimum value of C<0000> is completely transparent,
		1614	while C<ffff> is completely opaque). The two example colours from
		1615	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1616	C<rgba:0000/ff00/0000/f332>.
		1617
		1618	You probably need to specify B<"-depth 32">, too, to force a visual with
		1619	alpha channels, and have the luck that your X-server uses ARGB pixel
		1620	layout, as X is far from just supporting ARGB visuals out of the box, and
		1621	rxvt-unicode just fudges around.
		1622
		1623	For example, the following selects an almost completely transparent black
		1624	background, and an almost opaque pink foreground:
		1625
		1626	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1627
		1628	When not using a background image, then the interpretation of the
		1629	alpha channel is up to your compositing manager (most interpret it as
		1630	transparency of course).
		1631
		1632	When using a background pixmap or pseudo-transparency, then the background
		1633	colour will always behave as if it were completely transparent (so the
		1634	background image shows instead), regardless of how it was specified, while
		1635	other colours will either be transparent as specified (the background
		1636	image will show through) on servers supporting the RENDER extension, or
		1637	fully opaque on servers not supporting the RENDER EXTENSION.
		1638
		1639	Please note that due to bugs in Xft, specifying alpha values might result
		1640	in garbage being displayed when the X-server does not support the RENDER
		1641	extension.
		1642
		1643	=head1 ENVIRONMENT
		1644
		1645	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1646
1319	=over 4	1647	=over 4
1320		1648
1321	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1322
1323	would yield White on Black, while on I<xterm>(1) it would yield Black
1324	on White.
1325
1326	=back
1327
1328	=head1 ENVIRONMENT
1329
1330	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1331
1332	=over 4
1333
1334	=item B<TERM>	1649	=item B<TERM>
1335		1650
1336	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1651	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1337	resources or on the commandline.	1652	resources or on the command line.
1338		1653
1339	=item B<COLORTERM>	1654	=item B<COLORTERM>
1340		1655
1341	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1656	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1342	compiled with XPM support, and optionally with the added extension	1657	compiled with background image support, and optionally with the added
1343	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1658	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1659	screen.
1344		1660
1345	=item B<COLORFGBG>	1661	=item B<COLORFGBG>
1346		1662
1347	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1663	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1348	the colour code used as default foreground/text colour (or the string	1664	the colour code used as default foreground/text colour (or the string
1349	C<default> to indicate that the default-colour escape sequence is to be	1665	C<default> to indicate that the default-colour escape sequence is to be
1350	used), C<bg> is the colour code used as default background colour (or the	1666	used), C<bg> is the colour code used as default background colour (or the
1351	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1667	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1352	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1668	was compiled with background image support. Libraries like C<ncurses>
1353	(and do) use this information to optimize screen output.	1669	and C<slang> can (and do) use this information to optimize screen output.
1354		1670
1355	=item B<WINDOWID>	1671	=item B<WINDOWID>
1356		1672
1357	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1673	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1358	window, which usually has subwindows for the scrollbar, the terminal	1674	window, which usually has subwindows for the scrollbar, the terminal
…		…
1364	C<--with-terminfo=PATH>.	1680	C<--with-terminfo=PATH>.
1365		1681
1366	=item B<DISPLAY>	1682	=item B<DISPLAY>
1367		1683
1368	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1684	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1369	display in it's child processes.	1685	display in its child processes if C<-display> isn't used to override. It
		1686	defaults to C<:0> if it doesn't exist.
1370		1687
1371	=item B<SHELL>	1688	=item B<SHELL>
1372		1689
1373	The shell to be used for command execution, defaults to C</bin/sh>.	1690	The shell to be used for command execution, defaults to C</bin/sh>.
1374		1691
1375	=item B<RXVT_SOCKET>	1692	=item B<RXVT_SOCKET> [I<sic>]
1376		1693
1377	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1694	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1378	@@RXVT_NAME@@d(1).	1695	@@RXVT_NAME@@d(1).
1379		1696
1380	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1697	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1698
		1699	=item B<URXVT_PERL_LIB>
		1700
		1701	Additional F<:>-separated library search path for perl extensions. Will be
		1702	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1703	directory.
		1704
		1705	=item B<URXVT_PERL_VERBOSITY>
		1706
		1707	See L<@@RXVT_NAME@@perl>(3).
1381		1708
1382	=item B<HOME>	1709	=item B<HOME>
1383		1710
1384	Used to locate the default directory for the unix domain socket for	1711	Used to locate the default directory for the unix domain socket for
1385	daemon communications and to locate various resource files (such as	1712	daemon communications and to locate various resource files (such as
1386	C<.Xdefaults>)	1713	C<.Xdefaults>)
1387		1714
1388	=item B<XAPPLRESDIR>	1715	=item B<XAPPLRESDIR>
1389		1716
1390	Directory where various X resource files are being located.	1717	Directory where application-specific X resource files are located.
1391		1718
1392	=item B<XENVIRONMENT>	1719	=item B<XENVIRONMENT>
1393		1720
1394	If set and accessible, gives the name of a X resource file to be loaded by	1721	If set and accessible, gives the name of a X resource file to be loaded by
1395	@@RXVT_NAME@@.	1722	@@RXVT_NAME@@.
…		…
1400		1727
1401	=over 4	1728	=over 4
1402		1729
1403	=item B</usr/lib/X11/rgb.txt>	1730	=item B</usr/lib/X11/rgb.txt>
1404		1731
1405	Color names.	1732	Colour names.
1406		1733
1407	=back	1734	=back
1408		1735
1409	=head1 SEE ALSO	1736	=head1 SEE ALSO
1410		1737
		1738	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1411	@@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)	1739	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1412		1740
1413	=head1 CURRENT PROJECT COORDINATOR	1741	=head1 CURRENT PROJECT COORDINATOR
1414		1742
1415	=over 4	1743	=over 4
1416		1744
1417	=item Project Coordinator	1745	=item Project Coordinator
1418		1746
1419	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1747	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1420		1748
1421	L<http://software.schmorp.de/#rxvt-unicode>	1749	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1422		1750
1423	=back	1751	=back
1424		1752
1425	=head1 AUTHORS	1753	=head1 AUTHORS
1426		1754
…		…
1428		1756
1429	=item John Bovey	1757	=item John Bovey
1430		1758
1431	University of Kent, 1992, wrote the original Xvt.	1759	University of Kent, 1992, wrote the original Xvt.
1432		1760
1433	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1761	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1434		1762
1435	very heavily modified Xvt and came up with Rxvt	1763	very heavily modified Xvt and came up with Rxvt
1436		1764
1437	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1765	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1438		1766
1439	wrote the Greek Keyboard Input (no longer in code)	1767	wrote the Greek Keyboard Input (no longer in code)
1440		1768
1441	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1769	=item mj olesen <olesen@me.QueensU.CA>
1442		1770
1443	Wrote the menu system.	1771	Wrote the menu system.
1444		1772
1445	Project Coordinator (changes.txt 2.11 to 2.21)	1773	Project Coordinator (changes.txt 2.11 to 2.21)
1446		1774
1447	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1775	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1448		1776
1449	Project Coordinator (changes.txt 2.21a to 2.4.5)	1777	Project Coordinator (changes.txt 2.21a to 2.4.5)
1450		1778
1451	=item Geoff Wing L<< <gcw@pobox.com> >>	1779	=item Geoff Wing <gcw@pobox.com>
1452		1780
1453	Rewrote screen display and text selection routines. Project Coordinator	1781	Rewrote screen display and text selection routines.
		1782
1454	(changes.txt 2.4.6 - rxvt-unicode)	1783	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1455		1784
1456	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1785	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1457		1786
1458	Forked rxvt-unicode, rewrote most of the display code and internal	1787	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1459	character handling to store text in unicode, improve xterm	1788	extension, random hacks, numerous bugfixes and extensions.
1460	compatibility and apply numerous other bugfixes and extensions.
1461		1789
1462	Project Coordinator (Changes 1.0 -)	1790	Project Coordinator (Changes 1.0 -)
1463		1791
		1792	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
		1793
		1794	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1795
1464	=back	1796	=back
1465		1797

Diff Legend

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