ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/doc/rxvt.1.pod

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

Diff Legend

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