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

Diff Legend

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