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.86 by root, Fri Jan 6 05:28:55 2006 UTC vs.
Revision 1.248 by sf-exg, Fri Oct 13 17:13:58 2017 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
…		…
172	resource B<borderColor>.	173	resource B<borderColor>.
173		174
174	=item B<-fn> I<fontlist>	175	=item B<-fn> I<fontlist>
175		176
176	Select the fonts to be used. This is a comma separated list of font names	177	Select the fonts to be used. This is a comma separated list of font names
177	that are used in turn when trying to display Unicode 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>.
379		410
380	=item B<-insecure>	411	=item B<-insecure>
381		412
382	Enable "insecure" mode, which currently enables most of the escape	413	Enable "insecure" mode, which currently enables most of the escape
383	sequences that echo strings. See the resource B<insecure> for more	414	sequences that echo strings. See the resource B<insecure> for more
…		…
404	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	435	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405	will not immediately destroy its window when the program executed within	436	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	437	it exits. Instead, it will wait till it is being killed or closed by the
407	user; resource B<hold>.	438	user; resource B<hold>.
408		439
		440	=item B<-cd> I<path>
		441
		442	Sets the working directory for the shell (or the command specified via
		443	B<-e>). The I<path> must be an absolute path and it must exist for
		444	@@RXVT_NAME@@ to start; resource B<chdir>.
		445
		446	=item B<-xrm> I<string>
		447
		448	Works like the X Toolkit option of the same name, by adding the I<string>
		449	as if it were specified in a resource file. Resource values specified this
		450	way take precedence over all other resource specifications.
		451
		452	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		453	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		454	options can be specified as long-options on the commandline, so use
		455	of B<-xrm> is mostly limited to cases where you want to specify other
		456	resources (e.g. for input methods) or for compatibility with other
		457	programs.
		458
409	=item B<-keysym.>I<sym> I<string>	459	=item B<-keysym.>I<sym> I<string>
410		460
411	Remap a key symbol. See resource B<keysym>.	461	Remap a key symbol. See resource B<keysym>.
412		462
413	=item B<-embed> I<windowid>	463	=item B<-embed> I<windowid>
414		464
415	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	465	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416	which enables applications to easily embed a terminal.	466	which enables applications to easily embed a terminal.
417		467
418	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	468	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	469	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	470	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.	473	The window will not be destroyed when @@RXVT_NAME@@ exits.
424		474
425	It might be useful to know that @@RXVT_NAME@@ will not close file	475	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	476	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	477	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	478	terminal. This works regardless of whether the C<-embed> option was used or
429	not.	479	not.
430		480
431	Here is a short Gtk2-perl snippet that illustrates how this option can be	481	Here is a short Gtk2-perl snippet that illustrates how this option can be
432	used (a longer example is in F<doc/embed>):	482	used (a longer example is in F<doc/embed>):
433		483
…		…
438	});	488	});
439		489
440	=item B<-pty-fd> I<file descriptor>	490	=item B<-pty-fd> I<file descriptor>
441		491
442	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	492	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	493	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	494	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445	without having to run a program within it.	495	without having to run a program within it.
446		496
447	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	497	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	498	entries and will not tinker with pty/tty permissions - you have to do that
449	yourself if you want that.	499	yourself if you want that.
450		500
451	As an extremely special case, specifying C<-1> will completely suppress	501	As an extremely special case, specifying C<-1> will completely suppress
452	pty/tty operations.	502	pty/tty operations, which is probably only useful in conjunction with some
		503	perl extension that manages the terminal.
453		504
454	Here is a example in perl that illustrates how this option can be used (a	505	Here is a example in perl that illustrates how this option can be used (a
455	longer example is in F<doc/pty-fd>):	506	longer example is in F<doc/pty-fd>):
456		507
457	use IO::Pty;	508	use IO::Pty;
…		…
466	my $slave = $pty->slave;	517	my $slave = $pty->slave;
467	while (<$slave>) { print $slave "got <$_>\n" }	518	while (<$slave>) { print $slave "got <$_>\n" }
468		519
469	=item B<-pe> I<string>	520	=item B<-pe> I<string>
470		521
471	Colon-separated list of perl extension scripts to use in this terminal	522	Comma-separated list of perl extension scripts to use (or not to use) in
472	instance. See resource B<perl-ext>.	523	this terminal instance. See resource B<perl-ext> for details.
473		524
474	=back	525	=back
475		526
476	=head1 RESOURCES (available also as long-options)	527	=head1 RESOURCES
477		528
478	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	529	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479	options) compiled into your version.	530	options) compiled into your version. All resources are also available as
		531	long-options.
480		532
481	There are two different methods that @@RXVT_NAME@@ can use to get the	533	You can set and change the resources using X11 tools like B<xrdb>. Many
482	Xresource data: using the X libraries (Xrm*-functions) or internal	534	distribution do also load settings from the B<~/.Xresources> file when X
483	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	536	with later settings overwriting earlier ones:
485	resources using X11 tools like B<xrdb>. Many distribution do also load
486	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487	will consult the following files/resources in order, with later settings
488	overwriting earlier ones:
489		537
490	1. system-wide app-defaults file, either locale-dependent OR global
491	2. app-defaults file in $XAPPLRESDIR	538	1. app-defaults file in $XAPPLRESDIR
		539	2. $HOME/.Xdefaults
492	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	540	3. RESOURCE_MANAGER property on root-window of screen 0
493	4. SCREEN_RESOURCES for the current screen	541	4. SCREEN_RESOURCES property on root-window of the current screen
494	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	542	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		543	6. resources specified via -xrm on the commandline
495		544
496	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498	set in XAPPLOADDIR/URxvt (compile-time defined: usually
499	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	545	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	546	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
503	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	547	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
504	easily configured, while the class name B<URxvt> allows resources	548	configured, while the class name B<URxvt> allows resources unique to
505	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	549	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506	shared between different B<@@RXVT_NAME@@> configurations. If no	550	configurations. If no resources are specified, suitable defaults will
507	resources are specified, suitable defaults will be used. Command-line	551	be used. Command-line arguments can be used to override resource
508	arguments can be used to override resource settings. The following	552	settings. The following resources are supported (you might want to
509	resources are allowed:	553	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		554	extensions not documented here):
510		555
511	=over 4	556	=over 4
		557
		558	=item B<depth:> I<bitdepth>
		559
		560	Compile I<xft>: Attempt to find a visual with the given bit depth;
		561	option B<-depth>.
		562
		563	=item B<buffered:> I<boolean>
		564
		565	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		566	On some card/driver combination enabling it slightly decreases
		567	performance, on most it greatly helps it. The slowdown is small, so it
		568	should normally be enabled.
512		569
513	=item B<geometry:> I<geom>	570	=item B<geometry:> I<geom>
514		571
515	Create the window with the specified X window geometry [default 80x24];	572	Create the window with the specified X window geometry [default 80x24];
516	option B<-geometry>.	573	option B<-geometry>.
…		…
530	Use the specified colour for the colour value I<n>, where 0-7	587	Use the specified colour for the colour value I<n>, where 0-7
531	corresponds to low-intensity (normal) colours and 8-15 corresponds to	588	corresponds to low-intensity (normal) colours and 8-15 corresponds to
532	high-intensity (bold = bright foreground, blink = bright background)	589	high-intensity (bold = bright foreground, blink = bright background)
533	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	590	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
534	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	591	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
535	names used are listed in the B<COLORS AND GRAPHICS> section.	592	names used are listed in the B<COLOURS AND GRAPHICS> section.
536		593
537	Colours higher than 15 cannot be set using resources (yet), but can be	594	Colours higher than 15 cannot be set using resources (yet), but can be
538	changed using an escape command (see @@RXVT_NAME@@(7)).	595	changed using an escape command (see @@RXVT_NAME@@(7)).
539		596
540	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	597	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
551	=item B<colorUL:> I<colour>	608	=item B<colorUL:> I<colour>
552		609
553	Use the specified colour to display underlined characters when the	610	Use the specified colour to display underlined characters when the
554	foreground colour is the default.	611	foreground colour is the default.
555		612
556	=item B<colorRV:> I<colour>
557
558	Use the specified colour as the background for reverse video
559	characters.
560
561	=item B<underlineColor:> I<colour>	613	=item B<underlineColor:> I<colour>
562		614
563	If set, use the specified colour as the colour for the underline	615	If set, use the specified colour as the colour for the underline
564	itself. If unset, use the foreground colour.	616	itself. If unset, use the foreground colour.
		617
		618	=item B<highlightColor:> I<colour>
		619
		620	If set, use the specified colour as the background for highlighted
		621	characters. If unset, use reverse video.
		622
		623	=item B<highlightTextColor:> I<colour>
		624
		625	If set and highlightColor is set, use the specified colour as the
		626	foreground for highlighted characters.
565		627
566	=item B<cursorColor:> I<colour>	628	=item B<cursorColor:> I<colour>
567		629
568	Use the specified colour for the cursor. The default is to use the	630	Use the specified colour for the cursor. The default is to use the
569	foreground colour; option B<-cr>.	631	foreground colour; option B<-cr>.
…		…
576		638
577	=item B<reverseVideo:> I<boolean>	639	=item B<reverseVideo:> I<boolean>
578		640
579	B<True>: simulate reverse video by foreground and background colours;	641	B<True>: simulate reverse video by foreground and background colours;
580	option B<-rv>. B<False>: regular screen colours [default]; option	642	option B<-rv>. B<False>: regular screen colours [default]; option
581	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	643	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
582		644
583	=item B<jumpScroll:> I<boolean>	645	=item B<jumpScroll:> I<boolean>
584		646
585	B<True>: specify that jump scrolling should be used. When scrolling	647	B<True>: specify that jump scrolling should be used. When receiving lots
586	quickly, fewer screen updates are performed [default]; option B<-j>.	648	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		649	has been read, resulting in fewer updates while still displaying every
		650	received line; option B<-j>.
		651
587	B<False>: specify that smooth scrolling should be used; option B<+j>.	652	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		653	force a screen refresh on each new line it received; option B<+j>.
588		654
589	=item B<inheritPixmap:> I<boolean>	655	=item B<skipScroll:> I<boolean>
590		656
591	B<True>: make the background inherit the parent windows' pixmap, giving	657	B<True>: (the default) specify that skip scrolling should be used. When
592	artificial transparency. B<False>: do not inherit the parent windows'	658	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
593	pixmap.	659	(around 60 times per second), resulting in far fewer updates. This can
		660	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		661	option B<-ss>.
		662
		663	B<False>: specify that everything is to be displayed, even
		664	if the refresh is too fast for the human eye to read anything (or the
		665	monitor to display anything); option B<+ss>.
594		666
595	=item B<fading:> I<number>	667	=item B<fading:> I<number>
596		668
597	Fade the text by the given percentage when focus is lost; option B<-fade>.	669	Fade the text by the given percentage when focus is lost; option B<-fade>.
598		670
599	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
600		672
601	Fade to this colour, when fading is used (see B<fading:>). The default	673	Fade to this colour, when fading is used (see B<fading:>). The default
602	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
603		675
604	=item B<tintColor:> I<colour>	676	=item B<iconFile:> I<file>
605		677
606	Tint the transparent background pixmap with the given colour; option	678	Set the application icon pixmap; option B<-icon>.
607	B<-tint>.
608
609	=item B<shading:> I<number>
610
611	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
612	image in addition to tinting it.
613		679
614	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
615		681
616	Use the specified colour for the scrollbar [default #B2B2B2].	682	Use the specified colour for the scrollbar [default #B2B2B2].
617		683
…		…
623	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
624		690
625	The colour of the border around the text area and between the scrollbar	691	The colour of the border around the text area and between the scrollbar
626	and the text.	692	and the text.
627		693
628	=item B<backgroundPixmap:> I<file[;geom]>
629
630	Use the specified XPM file (note the `.xpm' extension is optional) for
631	the background and also optionally specify its scaling with a geometry
632	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
633	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
634	centre (percent). A scale of 0 displays the image with tiling. A scale
635	of 1 displays the image without any scaling. A scale of 2 to 9
636	specifies an integer number of images in that direction. No image will
637	be magnified beyond 10 times its original size. The maximum permitted
638	scale is 1000. [default 0x0+50+50]
639
640	=item B<menu:> I<file[;tag]>
641
642	Read in the specified menu file (note the `.menu' extension is
643	optional) and also optionally specify a starting tag to find. See the
644	reference documentation for details on the syntax for the menuBar.
645
646	=item B<path:> I<path>
647
648	Specify the colon-delimited search path for finding files (XPM and
649	menus), in addition to the paths specified by the B<RXVTPATH> and
650	B<PATH> environment variables.
651
652	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
653		695
654	Select the fonts to be used. This is a comma separated list of font	696	Select the fonts to be used. This is a comma separated list of font names
655	names that are used in turn when trying to display Unicode characters.	697	that are checked in order when trying to find glyphs for characters. The
656	The first font defines the cell size for characters; other fonts might	698	first font defines the cell size for characters; other fonts might be
657	be smaller, but not larger. A reasonable default font list is always	699	smaller, but not (in general) larger. A (hopefully) reasonable default
658	appended to it; option B<-fn>.	700	font list is always appended to it; option B<-fn>.
659		701
660	Each font can either be a standard X11 core font (XLFD) name, with	702	Each font can either be a standard X11 core font (XLFD) name, with
661	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	703	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662		704
663	In addition, each font can be prefixed with additional hints and	705	In addition, each font can be prefixed with additional hints and
…		…
665	hint currently is C<codeset=codeset-name>, and this is only used for Xft	707	hint currently is C<codeset=codeset-name>, and this is only used for Xft
666	fonts.	708	fonts.
667		709
668	For example, this font resource	710	For example, this font resource
669		711
670	URxvt*font: 9x15bold,\	712	URxvt.font: 9x15bold,\
671	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	713	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
672	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	714	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
673	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	715	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674	xft:Code2000:antialias=false	716	xft:Code2000:antialias=false
675		717
…		…
678	it is named first) and thus defines the character cell grid to be 9 pixels	720	it is named first) and thus defines the character cell grid to be 9 pixels
679	wide and 15 pixels high.	721	wide and 15 pixels high.
680		722
681	The second font is just used to add additional unicode characters not in	723	The second font is just used to add additional unicode characters not in
682	the base font, likewise the third, which is unfortunately non-bold, but	724	the base font, likewise the third, which is unfortunately non-bold, but
683	the bold version of the font does contain less characters, so this is a	725	the bold version of the font does contain fewer characters, so this is a
684	useful supplement.	726	useful supplement.
685		727
686	The third font is an Xft font with aliasing turned off, and the characters	728	The third font is an Xft font with aliasing turned off, and the characters
687	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	729	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
688	contains other characters, but we are not interested in them.	730	contains other characters, but we are not interested in them.
…		…
712	text font will being used for the given style.	754	text font will being used for the given style.
713		755
714	=item B<intensityStyles:> I<boolean>	756	=item B<intensityStyles:> I<boolean>
715		757
716	When font styles are not enabled, or this option is enabled (B<True>,	758	When font styles are not enabled, or this option is enabled (B<True>,
717	option B<-is>, the default), bold and italic font styles imply high	759	option B<-is>, the default), bold/blink font styles imply high
718	intensity foreground/backround colours. Disabling this option (B<False>,	760	intensity foreground/background colours. Disabling this option (B<False>,
719	option B<+is>) disables this behaviour, the high intensity colours are not	761	option B<+is>) disables this behaviour, the high intensity colours are not
720	reachable.	762	reachable.
721
722	=item B<selectstyle:> I<mode>
723
724	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
725	xterm style with 2.20 old word selection, or anything else which gives
726	xterm style selection.
727
728	=item B<scrollstyle:> I<mode>
729
730	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
731	the author's favourite.
732		763
733	=item B<title:> I<string>	764	=item B<title:> I<string>
734		765
735	Set window title string, the default title is the command-line	766	Set window title string, the default title is the command-line
736	specified after the B<-e> option, if any, otherwise the application	767	specified after the B<-e> option, if any, otherwise the application
…		…
745	=item B<mapAlert:> I<boolean>	776	=item B<mapAlert:> I<boolean>
746		777
747	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	778	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
748	de-iconify (map) on receipt of a bell character [default].	779	de-iconify (map) on receipt of a bell character [default].
749		780
		781	=item B<urgentOnBell:> I<boolean>
		782
		783	B<True>: set the urgency hint for the wm on receipt of a bell character.
		784	B<False>: do not set the urgency hint [default].
		785
		786	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		787
750	=item B<visualBell:> I<boolean>	788	=item B<visualBell:> I<boolean>
751		789
752	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	790	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
753	B<False>: no visual bell [default]; option B<+vb>.	791	B<False>: no visual bell [default]; option B<+vb>.
754		792
…		…
756		794
757	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	795	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
758	the shell; option B<-ls>. B<False>: start as a normal sub-shell	796	the shell; option B<-ls>. B<False>: start as a normal sub-shell
759	[default]; option B<+ls>.	797	[default]; option B<+ls>.
760		798
		799	=item B<multiClickTime:> I<number>
		800
		801	Specify the maximum time in milliseconds between multi-click select
		802	events. The default is 500 milliseconds; option B<-mc>.
		803
761	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
762		805
763	B<True>: inhibit writing record into the system log file B<utmp>;	806	B<True>: inhibit writing record into the system log file B<utmp>;
764	option B<-ut>. B<False>: write record into the system log file B<utmp>	807	option B<-ut>. B<False>: write record into the system log file B<utmp>
765	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
772		815
773	The string will be interpreted as if typed into the shell as-is.	816	The string will be interpreted as if typed into the shell as-is.
774		817
775	Example:	818	Example:
776		819
777	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	820	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778		821
779	This creates a new file in your home directory with the screen contents	822	This creates a new file in your home directory with the screen contents
780	everytime you hit C<Print>.	823	every time you hit C<Print>.
		824
		825	=item B<scrollstyle:> I<mode>
		826
		827	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		828	the author's favourite.
		829
		830	=item B<thickness:> I<number>
		831
		832	Set the scrollbar width in pixels.
781		833
782	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
783		835
784	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
785	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
…		…
805	B<False>: do not scroll to bottom when tty receives output; option	857	B<False>: do not scroll to bottom when tty receives output; option
806	B<+si>.	858	B<+si>.
807		859
808	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
809		861
810	B<True>: scroll with scrollback buffer when tty receives new lines (and	862	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
811	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	863	try to show the same lines) and B<scrollTtyOutput> is False; option
812	with scrollback buffer when tty recieves new lines; option B<+sw>.	864	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		865	new lines; option B<+sw>.
813		866
814	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
815		868
816	B<True>: scroll to bottom when a non-special key is pressed. Special keys	869	B<True>: scroll to bottom when a non-special key is pressed. Special keys
817	are those which are intercepted by rxvt-unicode for special handling and	870	are those which are intercepted by rxvt-unicode for special handling and
818	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	871	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
819	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
820		873
821	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
822		875
823	Save I<number> lines in the scrollback buffer [default 64]. This	876	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
824	resource is limited on most machines to 65535; option B<-sl>.
825		877
826	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
827		879
828	Internal border of I<number> pixels. This resource is limited to 100;	880	Internal border of I<number> pixels. This resource is limited to 100;
829	option B<-b>.	881	option B<-b>.
…		…
848	=item B<termName:> I<termname>	900	=item B<termName:> I<termname>
849		901
850	Specifies the terminal type name to be set in the B<TERM> environment	902	Specifies the terminal type name to be set in the B<TERM> environment
851	variable; option B<-tn>.	903	variable; option B<-tn>.
852		904
853	=item B<linespace:> I<number>	905	=item B<lineSpace:> I<number>
854		906
855	Specifies number of lines (pixel height) to insert between each row of	907	Specifies number of lines (pixel height) to insert between each row of
856	the display [default 0]; option B<-lsp>.	908	the display [default 0]; option B<-lsp>.
857		909
858	=item B<meta8:> I<boolean>	910	=item B<meta8:> I<boolean>
…		…
872		924
873	=item B<cursorBlink:> I<boolean>	925	=item B<cursorBlink:> I<boolean>
874		926
875	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	927	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
876	option B<-bc>.	928	option B<-bc>.
		929
		930	=item B<cursorUnderline:> I<boolean>
		931
		932	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		933	option B<-uc>.
877		934
878	=item B<pointerBlank:> I<boolean>	935	=item B<pointerBlank:> I<boolean>
879		936
880	B<True>: blank the pointer when a key is pressed or after a set number	937	B<True>: blank the pointer when a key is pressed or after a set number
881	of seconds of inactivity. B<False>: the pointer is always visible	938	of seconds of inactivity. B<False>: the pointer is always visible
…		…
887		944
888	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
889		946
890	Mouse pointer background colour.	947	Mouse pointer background colour.
891		948
		949	=item B<pointerShape:> I<string>
		950
		951	Compile I<frills>: Specifies the name of the mouse pointer shape
		952	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		953	file for possible values (omit the C<XC_> prefix).
		954
892	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
893		956
894	Specifies number of seconds before blanking the pointer [default 2]. Use a	957	Specifies number of seconds before blanking the pointer [default 2]. Use a
895	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
896		959
897	=item B<backspacekey:> I<string>	960	=item B<backspacekey:> I<string>
898		961
899	The string to send when the backspace key is pressed. If set to B<DEC>	962	The string to send when the backspace key is pressed. If set to B<DEC>
900	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	963	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
901	(code 8) - which can be reversed with the appropriate DEC private mode	964	(code 8) - which can be reversed with the appropriate DEC private mode
902	escape sequence.	965	escape sequence.
903		966
904	=item B<deletekey:> I<string>	967	=item B<deletekey:> I<string>
905		968
…		…
907	pressed. If unset it will send the sequence traditionally associated	970	pressed. If unset it will send the sequence traditionally associated
908	with the B<Execute> key.	971	with the B<Execute> key.
909		972
910	=item B<cutchars:> I<string>	973	=item B<cutchars:> I<string>
911		974
912	The characters used as delimiters for double-click word selection. The	975	The characters used as delimiters for double-click word selection
913	built-in default:	976	(whitespace delimiting is added automatically if resource is given).
914		977
		978	When the perl selection extension is in use (the default if compiled
		979	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		980	characters will be created (if the resource exists, otherwise, no regex
		981	will be created). In this mode, characters outside ISO-8859-1 can be used.
		982
		983	When the selection extension is not used, only ISO-8859-1 characters can
		984	be used. If not specified, the built-in default is used:
		985
915	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
916		987
917	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
918		989
919	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
920		991
921	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
922		993
923	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
924		995
…		…
954	default. (Note that many other terminals, including xterm, have these	1025	default. (Note that many other terminals, including xterm, have these
955	sequences enabled by default, which doesn't make it safer, though).	1026	sequences enabled by default, which doesn't make it safer, though).
956		1027
957	You can enable them by setting this boolean resource or specifying	1028	You can enable them by setting this boolean resource or specifying
958	B<-insecure> as an option. At the moment, this enables display-answer,	1029	B<-insecure> as an option. At the moment, this enables display-answer,
959	locale, findfont, icon label and window title requests as well as dynamic	1030	locale, findfont, icon label and window title requests.
960	menubar dispatch.
961		1031
962	=item B<modifier:> I<modifier>	1032	=item B<modifier:> I<modifier>
963		1033
964	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1034	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
965	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1035	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
969		1039
970	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1040	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
971	character is passed through. It may contain escape values as described	1041	character is passed through. It may contain escape values as described
972	in the entry on B<keysym> following.	1042	in the entry on B<keysym> following.
973		1043
974	=item B<secondaryScreen:> I<bool>	1044	=item B<secondaryScreen:> I<boolean>
975		1045
976	Turn on/off secondary screen (default enabled).	1046	Turn on/off secondary screen (default enabled).
977		1047
978	=item B<secondaryScroll:> I<bool>	1048	=item B<secondaryScroll:> I<boolean>
979		1049
980	Turn on/off secondary screen scroll (default enabled). If the this	1050	Turn on/off secondary screen scroll (default enabled). If this
981	option is enabled, scrolls on the secondary screen will change the	1051	option is enabled, scrolls on the secondary screen will change the
982	scrollback buffer and switching to/from the secondary screen will	1052	scrollback buffer and, when secondaryScreen is off, switching
983	instead scroll the screen up.	1053	to/from the secondary screen will instead scroll the screen up.
984		1054
985	=item B<hold>: I<bool>	1055	=item B<hold>: I<boolean>
986		1056
987	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1057	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988	will not immediately destroy its window when the program executed within	1058	will not immediately destroy its window when the program executed within
989	it exits. Instead, it will wait till it is being killed or closed by the	1059	it exits. Instead, it will wait till it is being killed or closed by the
990	user.	1060	user.
991		1061
		1062	=item B<chdir>: I<path>
		1063
		1064	Sets the working directory for the shell (or the command specified via
		1065	B<-e>). The I<path> must be an absolute path and it must exist for
		1066	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1067	directory will be used; option B<-cd>.
		1068
992	=item B<keysym.>I<sym>: I<string>	1069	=item B<keysym.>I<sym>: I<action>
993		1070
994	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1071	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
995	intervening resource name B<keysym.> cannot be omitted.	1072	resource name B<keysym.> cannot be omitted.
996		1073
997	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1074	Using this resource, you can map key combinations such as
998	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1075	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
999	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1076	string than would normally result from that combination, making the
1000	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1077	terminal scroll up or down the way you want it, or any other thing an
1001	B<2>, B<3>, B<4>, B<5>.	1078	extension might provide.
		1079
		1080	The key combination that triggers the action, I<sym>, has the following format:
		1081
		1082	(modifiers-)key
		1083
		1084	Where I<modifiers> can be any combination of the following full or
		1085	abbreviated modifier names:
		1086
		1087	=begin table
		1088
		1089	B<ISOLevel3> B<I>
		1090	B<AppKeypad> B<K>
		1091	B<Control> B<C>
		1092	B<NumLock> B<N>
		1093	B<Shift> B<S>
		1094	B<Meta> B<M> B<A>
		1095	B<Lock> B<L>
		1096	B<Mod1> B<1>
		1097	B<Mod2> B<2>
		1098	B<Mod3> B<3>
		1099	B<Mod4> B<4>
		1100	B<Mod5> B<5>
		1101
		1102	=end table
1002		1103
1003	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1104	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1004	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1105	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1005	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1106	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1006	current application keymap mode state.	1107	current application keymap mode state.
1007		1108
1008	The spellings of I<key> can be obtained by using B<xev>(1) command or	1109	Due the the large number of modifier combinations, a key mapping will
1009	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1110	match if I<at least> the specified identifiers are being set, and no other
		1111	key mappings with those and more bits are being defined. That means that
		1112	defining a mapping for C<a> will automatically provide definitions for
		1113	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1114	themselves. See the C<builtin:> action, below, for a way to work around
		1115	this when this is a problem.
		1116
		1117	The spelling of I<key> depends on your implementation of X. An easy way to
		1118	find a key name is to use the B<xev>(1) command. You can find a list by
		1119	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1010	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1120	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1011	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1121	value (B<0x0000 - 0xFFFF>).
1012	performed in an exact manner; however, the closest match is assured.
1013		1122
1014	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1123	As with any resource value, the I<action> string may contain backslash
1015	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1124	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1016	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1125	number), see RESOURCES in C<man 7 X> for further details.
1017	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018	can start or end with whitespace.
1019		1126
1020	Please note that you need to double the C<\> when using	1127	An action starts with an action prefix that selects a certain type
1021	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1128	of action, followed by a colon. An action string without colons is
1022	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1129	interpreted as a literal string to pass to the tty (as if it was
1023	@@RXVT_NAME@@'s own processing).	1130	prefixed with C<string:>).
1024		1131
1025	You can define a range of keysyms in one shot by providing a I<string>	1132	The following action prefixes are known - extensions can provide
1026	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1133	additional prefixes:
		1134
		1135	=over 4
		1136
		1137	=item string:STRING
		1138
		1139	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1140	then the remaining C<STRING> will be passed to the program running in the
		1141	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1142	string C<echo rm -rf /> followed by a newline:
		1143
		1144	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1145
		1146	This could in theory be used to completely redefine your keymap.
		1147
		1148	In addition, for actions of this type, you can define a range of
		1149	keysyms in one shot by loading the C<keysym-list> perl extension and
		1150	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1027	should be a character not used by the strings.	1151	the delimiter `/' should be a character not used by the strings.
1028		1152
1029	Its usage can be demonstrated by an example:	1153	Its usage can be demonstrated by an example:
1030		1154
1031	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>	1155	URxvt.keysym.M-C-0x61: list|\033<|abc|>
1032		1156
1033	The above line is equivalent to the following three lines:	1157	The above line is equivalent to the following three lines:
1034		1158
1035	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1159	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1036	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1160	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1037	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1161	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1038		1162
		1163	=item command:STRING
		1164
1039	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1165	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1040	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1166	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1167	the opposite of C<string:> - instead of sending it to the program running
		1168	in the terminal, it will be treated as if it were program output). This is
		1169	most useful to feed command sequences into @@RXVT_NAME@@.
		1170
1041	example the following means "change the current locale to C<zh_CN.GBK>	1171	For example the following means "change the current locale to C<zh_CN.GBK>
1042	when Control-Meta-c is being pressed":	1172	when Control-Meta-c is being pressed":
1043		1173
1044	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1174	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1045		1175
1046	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1176	The following example will map Control-Meta-1 and Control-Meta-2 to
1047	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1177	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1048	manpage. For example, the F<selection> extension (activated via	1178	font-switching at runtime:
1049	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1050		1179
1051	URxvt.keysym.M-C-c: perl:selection:rot13	1180	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1181	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1052		1182
1053	Due the the large number of modifier combinations, a defined key mapping	1183	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1054	will match if at I<at least> the specified identifiers are being set, and	1184	info):
1055	no other key mappings with those and more bits are being defined. That
1056	means that defining a key map for C<a> will automatically provide
1057	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1058	mappings themselves.
1059		1185
1060	Unfortunately, this will override built-in key mappings. For example	1186	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1187	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1188
		1189	=item builtin:
		1190
		1191	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1192	key binding existed for the key combination. The obvious use is to undo
		1193	the effect of existing bindings. The not so obvious use is to reinstate
		1194	bindings when another binding overrides too many modifiers.
		1195
1061	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1196	For example if you overwrite the C<Insert> key you will disable
1062	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1197	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1063	user-defined keymap using the C<builtin:> replacement:	1198	"holes" into the user-defined keymap using the C<builtin:> replacement:
1064		1199
1065	URxvt.keysym.Insert: <my insert key sequence>	1200	URxvt.keysym.Insert: <my insert key sequence>
1066	URxvt.keysym.S-Insert: builtin:	1201	URxvt.keysym.S-Insert: builtin:
1067		1202
1068	The first line defines a mapping for C<Insert> and I<any> combination	1203	The first line defines a mapping for C<Insert> and I<any> combination
1069	of modifiers. The second line re-establishes the default mapping for	1204	of modifiers. The second line re-establishes the default mapping for
1070	C<Shift-Insert>.	1205	C<Shift-Insert>.
1071		1206
1072	The following example will map Control-Meta-1 and Control-Meta-2 to	1207	=item builtin-string:
1073	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1074	font-switching at runtime:
1075		1208
1076	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1209	This action is mainly useful to restore string mappings for keys that
1077	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1210	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1211	difficult to explain - basically, this action will send the string to the
		1212	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1213	action for it.
1078		1214
1079	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1215	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1080	info):	1216	selection when you press C<Shift-Insert>. With the following bindings, it
		1217	would instead emit the (undocumented, but what applications running in the
		1218	terminal might expect) sequence C<ESC [ 2 $> instead:
1081		1219
1082	URxvt.keysym.M-C-3: command:\033[8;25;80t	1220	URxvt.keysym.S-Insert: builtin-string:
1083	URxvt.keysym.M-C-4: command:\033[8;48;110t	1221	URxvt.keysym.C-S-Insert: builtin:
		1222
		1223	The first line disables the paste functionality for that key
		1224	combination, and the second reinstates the default behaviour for
		1225	C<Control-Shift-Insert>, which would otherwise be overridden.
		1226
		1227	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1228	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1229	this:
		1230
		1231	URxvt.keysym.C-M-c: builtin-string:
		1232	URxvt.keysym.C-M-v: builtin-string:
		1233
		1234	=item EXTENSION:STRING
		1235
		1236	An action of this form invokes the action B<STRING>, if any, provided
		1237	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1238	be loaded automatically if necessary.
		1239
		1240	Not all extensions define actions, but popular extensions that do
		1241	include the I<selection> and I<matcher> extensions (documented in their
		1242	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1243	respectively).
		1244
		1245	From the silly examples department, this will rot13-"encrypt"
		1246	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1247	keyboards:
		1248
		1249	URxvt.keysym.M-C-c: selection:rot13
		1250
		1251	=item perl:STRING *DEPRECATED*
		1252
		1253	This is a deprecated way of invoking commands provided by perl
		1254	extensions. It is still supported, but should not be used anymore.
		1255
		1256	=back
1084		1257
1085	=item B<perl-ext-common>: I<string>	1258	=item B<perl-ext-common>: I<string>
1086		1259
1087	=item B<perl-ext>: I<string>	1260	=item B<perl-ext>: I<string>
1088		1261
1089	Colon-separated list(s) of perl extension scripts to use in this terminal	1262	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1263	use in this terminal instance; option B<-pe>.
		1264
		1265	Extension names can be prefixed with a C<-> sign to prohibit using
		1266	them. This can be useful to selectively disable some extensions loaded
		1267	by default, or specified via the C<perl-ext-common> resource. For
		1268	example, C<default,-selection> will use all the default extensions except
		1269	C<selection>.
		1270
		1271	The default set includes the C<selection>, C<option-popup>,
		1272	C<selection-popup>, C<readline> and C<searchable-scrollback>
		1273	extensions, and extensions which are mentioned in B<keysym> resources.
		1274
		1275	Any extension such that a corresponding resource is given on the
		1276	command line is automatically appended to B<perl-ext>.
		1277
1090	instance. Each extension is looked up in the library directories, loaded	1278	Each extension is looked up in the library directories, loaded if
1091	if necessary, and bound to the current terminal instance. If this	1279	necessary, and bound to the current terminal instance. When the library
1092	resource is empty or missing, then the perl interpreter will not be	1280	search path contains multiple extension files of the same name, then the
1093	initialized. The idea behind two options is that B<perl-ext-common> will	1281	first one found will be used.
1094	be used for extensions that should be available to all instances, while	1282
1095	B<perl-ext> is used for specific instances; option B<-pe>.	1283	If both of these resources are the empty string, then the perl interpreter
		1284	will not be initialized. The rationale for having two options is that
		1285	B<perl-ext-common> will be used for extensions that should be available to
		1286	all instances, while B<perl-ext> is used for specific instances.
1096		1287
1097	=item B<perl-eval>: I<string>	1288	=item B<perl-eval>: I<string>
1098		1289
1099	Perl code to be evaluated when all extensions have been registered. See the	1290	Perl code to be evaluated when all extensions have been registered. See
1100	@@RXVT_NAME@@perl(3) manpage.	1291	the @@RXVT_NAME@@perl(3) manpage.
1101		1292
1102	=item B<perl-lib>: I<path>	1293	=item B<perl-lib>: I<path>
1103		1294
1104	Colon-separated list of additional directories that hold extension	1295	Colon-separated list of additional directories that hold extension
1105	scripts. When looking for extensions specified by the C<perl> resource,	1296	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1106	@@RXVT_NAME@@ will first look in these directories and then in	1297	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1107	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1298	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1108		1299
1109	See the @@RXVT_NAME@@perl(3) manpage.	1300	See the @@RXVT_NAME@@perl(3) manpage.
		1301
		1302	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1303
		1304	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1305	details.
		1306
		1307	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1308
		1309	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1310	for details.
		1311
		1312	=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
		1313
		1314	This resource is deprecated and will be removed. Use a B<keysym> resource
		1315	instead, e.g.:
		1316
		1317	URxvt.keysym.M-s: searchable-scrollback:start
		1318
		1319	=item B<url-launcher>: I<string>
		1320
		1321	Specifies the program to be started with a URL argument. Used by the
		1322	C<selection-popup> and C<matcher> perl extensions.
		1323
		1324	=item B<transient-for>: I<windowid>
		1325
		1326	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1327
		1328	=item B<override-redirect>: I<boolean>
		1329
		1330	Compile I<frills>: Sets override-redirect for the terminal window, making
		1331	it almost invisible to window managers; option B<-override-redirect>.
		1332
		1333	=item B<iso14755:> I<boolean>
		1334
		1335	Turn on/off ISO 14755 (default enabled).
		1336
		1337	=item B<iso14755_52:> I<boolean>
		1338
		1339	Turn on/off ISO 14755 5.2 mode (default enabled).
1110		1340
1111	=back	1341	=back
1112		1342
1113	=head1 THE SCROLLBAR	1343	=head1 THE SCROLLBAR
1114		1344
…		…
1133	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1363	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1134	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1364	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1135	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1365	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1136	respectively.	1366	respectively.
1137		1367
1138	=head1 TEXT SELECTION AND INSERTION	1368	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1139		1369
1140	The behaviour of text selection and insertion mechanism is similar to	1370	The behaviour of text selection and insertion/pasting mechanism is similar
1141	I<xterm>(1).	1371	to I<xterm>(1).
1142		1372
1143	=over 4	1373	=over 4
1144		1374
1145	=item B<Selection>:	1375	=item B<Selecting>:
1146		1376
1147	Left click at the beginning of the region, drag to the end of the region	1377	Left click at the beginning of the region, drag to the end of the region
1148	and release; Right click to extend the marked region; Left double-click	1378	and release; Right click to extend the marked region; Left double-click
1149	to select a word; Left triple-click to select the entire logical line	1379	to select a word; Left triple-click to select the entire logical line
1150	(which can span multiple screen lines), unless modified by resource	1380	(which can span multiple screen lines), unless modified by resource
…		…
1154	(Compile: I<frills>) will create a rectangular selection instead of a	1384	(Compile: I<frills>) will create a rectangular selection instead of a
1155	normal one. In this mode, every selected row becomes its own line in the	1385	normal one. In this mode, every selected row becomes its own line in the
1156	selection, and trailing whitespace is visually underlined and removed from	1386	selection, and trailing whitespace is visually underlined and removed from
1157	the selection.	1387	the selection.
1158		1388
1159	=item B<Insertion>:	1389	=item B<Pasting>:
1160		1390
1161	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1391	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1162	an B<@@RXVT_NAME@@> window causes the current text selection to be	1392	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1163	inserted as if it had been typed on the keyboard.	1393	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1394
		1395	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1396	inserted too.
		1397
		1398	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1399	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1400	binding causes the value of the internal selection to be copied to the
		1401	CLIPBOARD selection, while the second binding causes the value of the
		1402	CLIPBOARD selection to be inserted.
1164		1403
1165	=back	1404	=back
1166		1405
1167	=head1 CHANGING FONTS	1406	=head1 CHANGING FONTS
1168		1407
1169	Changing fonts (or font sizes, respectively) via the keypad is not yet	1408	Changing fonts (or font sizes, respectively) via the keypad is not yet
1170	supported in rxvt-unicode. Bug me if you need this.	1409	supported in rxvt-unicode. Bug me if you need this.
1171		1410
1172	You can, however, switch fonts at runtime using escape sequences (and	1411	You can, however, switch fonts at runtime using escape sequences, e.g.:
1173	therefore using the menubar), e.g.:
1174		1412
1175	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1413	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1414
		1415	You can use keyboard shortcuts, too:
		1416
		1417	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1418	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1176		1419
1177	rxvt-unicode will automatically re-apply these fonts to the output so far.	1420	rxvt-unicode will automatically re-apply these fonts to the output so far.
1178		1421
1179	=head1 ISO 14755 SUPPORT	1422	=head1 ISO 14755 SUPPORT
1180		1423
1181	ISO 14755 is a standard for entering and viewing unicode characters	1424	ISO 14755 is a standard for entering and viewing unicode characters
1182	and character codes using the keyboard. It consists of 4 parts. The	1425	and character codes using the keyboard. It consists of 4 parts. The
1183	first part is available rxvt-unicode has been compiled with	1426	first part is available if rxvt-unicode has been compiled with
1184	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1427	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1185	with C<--enable-iso14755>.	1428	with C<--enable-iso14755>.
1186		1429
1187	=over 4	1430	=over 4
1188		1431
…		…
1208	This mode lets you input characters representing the keycap symbols of	1451	This mode lets you input characters representing the keycap symbols of
1209	your keyboard, if representable in the current locale encoding.	1452	your keyboard, if representable in the current locale encoding.
1210		1453
1211	Start by pressing C<Control> and C<Shift> together, then releasing	1454	Start by pressing C<Control> and C<Shift> together, then releasing
1212	them. The next special key (cursor keys, home etc.) you enter will not	1455	them. The next special key (cursor keys, home etc.) you enter will not
1213	invoke it's usual function but instead will insert the corresponding	1456	invoke its usual function but instead will insert the corresponding
1214	keycap symbol. The symbol will only be entered when the key has been	1457	keycap symbol. The symbol will only be entered when the key has been
1215	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1458	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1216	C<ISO Level 2 Switch>, although your intention might have been to enter a	1459	C<ISO Level 2 Switch>, although your intention might have been to enter a
1217	reverse tab (Shift-Tab).	1460	reverse tab (Shift-Tab).
1218		1461
…		…
1246	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1489	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1247	it can be seen via the I<who(1)> command, and can accept messages. To	1490	it can be seen via the I<who(1)> command, and can accept messages. To
1248	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1491	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1249	on some systems or setgid to root or to some other group on others.	1492	on some systems or setgid to root or to some other group on others.
1250		1493
1251	=head1 COLORS AND GRAPHICS	1494	=head1 COLOURS AND GRAPHICS
1252		1495
1253	In addition to the default foreground and background colours,	1496	In addition to the default foreground and background colours,
1254	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1497	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1255	high-intensity bold/blink versions of the same). Here is a list of the	1498	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1256	colours with their B<rgb.txt> names.	1499	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1500	cube plus a 8 (24) colour greyscale ramp.
		1501
		1502	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1503	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1504	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1505	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1506	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1507	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1508	use many similar 24-bit colours. It's typically not a problem in common
		1509	scenarios.
		1510
		1511	Here is a list of the ANSI colours with their names.
1257		1512
1258	=begin table	1513	=begin table
1259		1514
1260	B<color0> (black) = Black	1515	B<color0> (black) = Black
1261	B<color1> (red) = Red3	1516	B<color1> (red) = Red3
…		…
1281	It is also possible to specify the colour values of B<foreground>,	1536	It is also possible to specify the colour values of B<foreground>,
1282	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1537	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1283	a number 0-15, as a convenient shorthand to reference the colour name of	1538	a number 0-15, as a convenient shorthand to reference the colour name of
1284	color0-color15.	1539	color0-color15.
1285		1540
		1541	The following text gives values for the standard 88 colour mode (and
		1542	values for the 256 colour mode in parentheses).
		1543
		1544	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1545
		1546	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1547	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1548
		1549	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1550	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1551	the RGB cube.
		1552
		1553	Together, all those colours implement the 88 (256) colour xterm
		1554	colours. Only the first 16 can be changed using resources currently, the
		1555	rest can only be changed via command sequences ("escape codes").
		1556
		1557	Applications are advised to use terminfo or command sequences to discover
		1558	number and RGB values of all colours (yes, you can query this...).
		1559
1286	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1560	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1287	always swapping the foreground/background colours. This is in contrast to	1561	always swapping the foreground/background colours. This is in contrast to
1288	I<xterm>(1) where the colours are only swapped if they have not otherwise	1562	I<xterm>(1) where the colours are only swapped if they have not otherwise
1289	been specified. For example,	1563	been specified. For example,
1290		1564
		1565	@@RXVT_NAME@@ -fg Black -bg White -rv
		1566
		1567	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1568	White.
		1569
		1570	=head2 ALPHA CHANNEL SUPPORT
		1571
		1572	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1573	their act together, rxvt-unicode will do its own alpha channel management:
		1574
		1575	You can prefix any colour with an opaqueness percentage enclosed in
		1576	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1577	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1578	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1579	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1580	is the recommended format to specify transparency values, and works with
		1581	all ways to specify a colour.
		1582
		1583	For complete control, rxvt-unicode also supports
		1584	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1585	specifications, where the additional C<aaaa> component specifies opacity
		1586	(alpha) values. The minimum value of C<0000> is completely transparent,
		1587	while C<ffff> is completely opaque). The two example colours from
		1588	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1589	C<rgba:0000/ff00/0000/f332>.
		1590
		1591	You probably need to specify B<"-depth 32">, too, to force a visual with
		1592	alpha channels, and have the luck that your X-server uses ARGB pixel
		1593	layout, as X is far from just supporting ARGB visuals out of the box, and
		1594	rxvt-unicode just fudges around.
		1595
		1596	For example, the following selects an almost completely transparent black
		1597	background, and an almost opaque pink foreground:
		1598
		1599	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1600
		1601	When not using a background image, then the interpretation of the
		1602	alpha channel is up to your compositing manager (most interpret it as
		1603	transparency of course).
		1604
		1605	When using a background pixmap or pseudo-transparency, then the background
		1606	colour will always behave as if it were completely transparent (so the
		1607	background image shows instead), regardless of how it was specified, while
		1608	other colours will either be transparent as specified (the background
		1609	image will show through) on servers supporting the RENDER extension, or
		1610	fully opaque on servers not supporting the RENDER EXTENSION.
		1611
		1612	Please note that due to bugs in Xft, specifying alpha values might result
		1613	in garbage being displayed when the X-server does not support the RENDER
		1614	extension.
		1615
		1616	=head1 ENVIRONMENT
		1617
		1618	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1619
1291	=over 4	1620	=over 4
1292		1621
1293	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1294
1295	would yield White on Black, while on I<xterm>(1) it would yield Black
1296	on White.
1297
1298	=back
1299
1300	=head1 ENVIRONMENT
1301
1302	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1303
1304	=over 4
1305
1306	=item B<TERM>	1622	=item B<TERM>
1307		1623
1308	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1624	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1309	resources or on the commandline.	1625	resources or on the command line.
1310		1626
1311	=item B<COLORTERM>	1627	=item B<COLORTERM>
1312		1628
1313	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1629	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1314	compiled with XPM support, and optionally with the added extension	1630	compiled with background image support, and optionally with the added
1315	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1631	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1632	screen.
1316		1633
1317	=item B<COLORFGBG>	1634	=item B<COLORFGBG>
1318		1635
1319	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1636	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1320	the colour code used as default foreground/text colour (or the string	1637	the colour code used as default foreground/text colour (or the string
1321	C<default> to indicate that the default-colour escape sequence is to be	1638	C<default> to indicate that the default-colour escape sequence is to be
1322	used), C<bg> is the colour code used as default background colour (or the	1639	used), C<bg> is the colour code used as default background colour (or the
1323	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1640	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1324	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1641	was compiled with background image support. Libraries like C<ncurses>
1325	(and do) use this information to optimize screen output.	1642	and C<slang> can (and do) use this information to optimize screen output.
1326		1643
1327	=item B<WINDOWID>	1644	=item B<WINDOWID>
1328		1645
1329	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1646	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1330	window, which usually has subwindows for the scrollbar, the terminal	1647	window, which usually has subwindows for the scrollbar, the terminal
…		…
1336	C<--with-terminfo=PATH>.	1653	C<--with-terminfo=PATH>.
1337		1654
1338	=item B<DISPLAY>	1655	=item B<DISPLAY>
1339		1656
1340	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1657	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1341	display in it's child processes.	1658	display in its child processes if C<-display> isn't used to override. It
		1659	defaults to C<:0> if it doesn't exist.
1342		1660
1343	=item B<SHELL>	1661	=item B<SHELL>
1344		1662
1345	The shell to be used for command execution, defaults to C</bin/sh>.	1663	The shell to be used for command execution, defaults to C</bin/sh>.
1346		1664
1347	=item B<RXVTPATH>
1348
1349	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1350	files.
1351
1352	=item B<PATH>
1353
1354	Used in the same way as C<RXVTPATH>.
1355
1356	=item B<RXVT_SOCKET>	1665	=item B<RXVT_SOCKET> [I<sic>]
1357		1666
1358	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1667	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1359	@@RXVT_NAME@@d(1).	1668	@@RXVT_NAME@@d(1).
1360		1669
1361	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1670	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1671
		1672	=item B<URXVT_PERL_LIB>
		1673
		1674	Additional F<:>-separated library search path for perl extensions. Will be
		1675	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1676	directory.
		1677
		1678	=item B<URXVT_PERL_VERBOSITY>
		1679
		1680	See L<@@RXVT_NAME@@perl>(3).
1362		1681
1363	=item B<HOME>	1682	=item B<HOME>
1364		1683
1365	Used to locate the default directory for the unix domain socket for	1684	Used to locate the default directory for the unix domain socket for
1366	daemon communications and to locate various resource files (such as	1685	daemon communications and to locate various resource files (such as
1367	C<.Xdefaults>)	1686	C<.Xdefaults>)
1368		1687
1369	=item B<XAPPLRESDIR>	1688	=item B<XAPPLRESDIR>
1370		1689
1371	Directory where various X resource files are being located.	1690	Directory where application-specific X resource files are located.
1372		1691
1373	=item B<XENVIRONMENT>	1692	=item B<XENVIRONMENT>
1374		1693
1375	If set and accessible, gives the name of a X resource file to be loaded by	1694	If set and accessible, gives the name of a X resource file to be loaded by
1376	@@RXVT_NAME@@.	1695	@@RXVT_NAME@@.
…		…
1381		1700
1382	=over 4	1701	=over 4
1383		1702
1384	=item B</usr/lib/X11/rgb.txt>	1703	=item B</usr/lib/X11/rgb.txt>
1385		1704
1386	Color names.	1705	Colour names.
1387		1706
1388	=back	1707	=back
1389		1708
1390	=head1 SEE ALSO	1709	=head1 SEE ALSO
1391		1710
		1711	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1392	@@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)	1712	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1393		1713
1394	=head1 CURRENT PROJECT COORDINATOR	1714	=head1 CURRENT PROJECT COORDINATOR
1395		1715
1396	=over 4	1716	=over 4
1397		1717
1398	=item Project Coordinator	1718	=item Project Coordinator
1399		1719
1400	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1720	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1401		1721
1402	L<http://software.schmorp.de/#rxvt-unicode>	1722	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1403		1723
1404	=back	1724	=back
1405		1725
1406	=head1 AUTHORS	1726	=head1 AUTHORS
1407		1727
…		…
1409		1729
1410	=item John Bovey	1730	=item John Bovey
1411		1731
1412	University of Kent, 1992, wrote the original Xvt.	1732	University of Kent, 1992, wrote the original Xvt.
1413		1733
1414	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1734	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1415		1735
1416	very heavily modified Xvt and came up with Rxvt	1736	very heavily modified Xvt and came up with Rxvt
1417		1737
1418	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1738	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1419		1739
1420	wrote the Greek Keyboard Input (no longer in code)	1740	wrote the Greek Keyboard Input (no longer in code)
1421		1741
1422	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1742	=item mj olesen <olesen@me.QueensU.CA>
1423		1743
1424	Wrote the menu system.	1744	Wrote the menu system.
1425		1745
1426	Project Coordinator (changes.txt 2.11 to 2.21)	1746	Project Coordinator (changes.txt 2.11 to 2.21)
1427		1747
1428	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1748	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1429		1749
1430	Project Coordinator (changes.txt 2.21a to 2.4.5)	1750	Project Coordinator (changes.txt 2.21a to 2.4.5)
1431		1751
1432	=item Geoff Wing L<< <gcw@pobox.com> >>	1752	=item Geoff Wing <gcw@pobox.com>
1433		1753
1434	Rewrote screen display and text selection routines. Project Coordinator	1754	Rewrote screen display and text selection routines.
		1755
1435	(changes.txt 2.4.6 - rxvt-unicode)	1756	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1436		1757
1437	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1758	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1438		1759
1439	Forked rxvt-unicode, rewrote most of the display code and internal	1760	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1440	character handling to store text in unicode, improve xterm	1761	extension, random hacks, numerous bugfixes and extensions.
1441	compatibility and apply numerous other bugfixes and extensions.
1442		1762
1443	Project Coordinator (Changes 1.0 -)	1763	Project Coordinator (Changes 1.0 -)
1444		1764
		1765	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
		1766
		1767	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1768
1445	=back	1769	=back
1446		1770

Diff Legend

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