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.120 by root, Sat Aug 12 01:37:11 2006 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/*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 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>
146
147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148	background image in addition to tinting it (i.e. B<-tint> must be
149	specified, too, e.g. C<-tint white>).
150		154
151	=item B<-bg> I<colour>	155	=item B<-bg> I<colour>
152		156
153	Window background colour; resource B<background>.	157	Window background colour; resource B<background>.
154		158
155	=item B<-fg> I<colour>	159	=item B<-fg> I<colour>
156		160
157	Window foreground colour; resource B<foreground>.	161	Window foreground colour; resource B<foreground>.
158
159	=item B<-pixmap> I<file[;geom]>
160
161	Compile I<XPM>: Specify XPM file for the background and also optionally
162	specify its scaling with a geometry string. Note you may need to
163	add quotes to avoid special shell interpretation of the C<;> in the
164	command-line; resource B<backgroundPixmap>.
165		162
166	=item B<-cr> I<colour>	163	=item B<-cr> I<colour>
167		164
168	The cursor colour; resource B<cursorColor>.	165	The cursor colour; resource B<cursorColor>.
169		166
…		…
214	italic> >> characters are to be printed. See resource B<boldItalicFont>	211	italic> >> characters are to be printed. See resource B<boldItalicFont>
215	for details.	212	for details.
216		213
217	=item B<-is>|B<+is>	214	=item B<-is>|B<+is>
218		215
219	Compile I<font-styles>: Bold/Italic font styles imply high intensity	216	Compile I<font-styles>: Bold/Blink font styles imply high intensity
220	foreground/background (default). See resource B<intensityStyles> for	217	foreground/background (default). See resource B<intensityStyles> for
221	details.	218	details.
222		219
223	=item B<-name> I<name>	220	=item B<-name> I<name>
224		221
…		…
228		225
229	=item B<-ls>|B<+ls>	226	=item B<-ls>|B<+ls>
230		227
231	Start as a login-shell/sub-shell; resource B<loginShell>.	228	Start as a login-shell/sub-shell; resource B<loginShell>.
232		229
		230	=item B<-mc> I<milliseconds>
		231
		232	Specify the maximum time between multi-click selections.
		233
233	=item B<-ut>|B<+ut>	234	=item B<-ut>|B<+ut>
234		235
235	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	236	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
236	B<utmpInhibit>.	237	B<utmpInhibit>.
237		238
…		…
241	B<visualBell>.	242	B<visualBell>.
242		243
243	=item B<-sb>|B<+sb>	244	=item B<-sb>|B<+sb>
244		245
245	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>.
246		256
247	=item B<-si>|B<+si>	257	=item B<-si>|B<+si>
248		258
249	Turn on/off scroll-to-bottom on TTY output inhibit; resource	259	Turn on/off scroll-to-bottom on TTY output inhibit; resource
250	B<scrollTtyOutput> has opposite effect.	260	B<scrollTtyOutput> has opposite effect.
…		…
257	=item B<-sw>|B<+sw>	267	=item B<-sw>|B<+sw>
258		268
259	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.
260	This only takes effect if B<-si> is also given; resource	270	This only takes effect if B<-si> is also given; resource
261	B<scrollWithBuffer>.	271	B<scrollWithBuffer>.
262
263	=item B<-sr>|B<+sr>
264
265	Put scrollbar on right/left; resource B<scrollBar_right>.
266
267	=item B<-st>|B<+st>
268
269	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270	resource B<scrollBar_floating>.
271		272
272	=item B<-ptab>|B<+ptab>	273	=item B<-ptab>|B<+ptab>
273		274
274	If enabled (default), "Horizontal Tab" characters are being stored as	275	If enabled (default), "Horizontal Tab" characters are being stored as
275	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
…		…
279		280
280	=item B<-bc>|B<+bc>	281	=item B<-bc>|B<+bc>
281		282
282	Blink the cursor; resource B<cursorBlink>.	283	Blink the cursor; resource B<cursorBlink>.
283		284
		285	=item B<-uc>|B<+uc>
		286
		287	Make the cursor underlined; resource B<cursorUnderline>.
		288
284	=item B<-iconic>	289	=item B<-iconic>
285		290
286	Start iconified, if the window manager supports that option.	291	Start iconified, if the window manager supports that option.
287	Alternative form is B<-ic>.	292	Alternative form is B<-ic>.
288		293
…		…
304		309
305	=item B<-bl>	310	=item B<-bl>
306		311
307	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.
308	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
309	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.
310		316
311	=item B<-override-redirect>	317	=item B<-override-redirect>
312		318
313	Compile I<frills>: Sets override-redirect on the window; resource	319	Compile I<frills>: Sets override-redirect on the window; resource
314	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.
315		326
316	=item B<-sbg>	327	=item B<-sbg>
317		328
318	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
319	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
…		…
322		333
323	=item B<-lsp> I<number>	334	=item B<-lsp> I<number>
324		335
325	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
326	the display. Useful to work around font rendering problems; resource	337	the display. Useful to work around font rendering problems; resource
327	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>.
328		346
329	=item B<-tn> I<termname>	347	=item B<-tn> I<termname>
330		348
331	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
332	B<TERM> environment variable. This terminal type must exist in the	350	B<TERM> environment variable. This terminal type must exist in the
…		…
367	=item B<-pt> I<style>	385	=item B<-pt> I<style>
368		386
369	Compile I<XIM>: input style for input method; B<OverTheSpot>,	387	Compile I<XIM>: input style for input method; B<OverTheSpot>,
370	B<OffTheSpot>, B<Root>; resource B<preeditType>.	388	B<OffTheSpot>, B<Root>; resource B<preeditType>.
371		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
372	=item B<-im> I<text>	393	=item B<-im> I<text>
373		394
374	Compile I<XIM>: input method name. resource B<inputMethod>.	395	Compile I<XIM>: input method name. resource B<inputMethod>.
375		396
376	=item B<-imlocale> I<string>	397	=item B<-imlocale> I<string>
…		…
386	for more info.	407	for more info.
387		408
388	=item B<-tcw>	409	=item B<-tcw>
389		410
390	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
391	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
392	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>.
393		425
394	=item B<-insecure>	426	=item B<-insecure>
395		427
396	Enable "insecure" mode, which currently enables most of the escape	428	Enable "insecure" mode, which currently enables most of the escape
397	sequences that echo strings. See the resource B<insecure> for more	429	sequences that echo strings. See the resource B<insecure> for more
…		…
410		442
411	=item B<-ssr>|B<+ssr>	443	=item B<-ssr>|B<+ssr>
412		444
413	Turn on/off secondary screen scroll (default enabled); resource	445	Turn on/off secondary screen scroll (default enabled); resource
414	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>.
415		455
416	=item B<-hold>|B<+hold>	456	=item B<-hold>|B<+hold>
417		457
418	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@@
419	will not immediately destroy its window when the program executed within	459	will not immediately destroy its window when the program executed within
420	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
421	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.
422		481
423	=item B<-keysym.>I<sym> I<string>	482	=item B<-keysym.>I<sym> I<string>
424		483
425	Remap a key symbol. See resource B<keysym>.	484	Remap a key symbol. See resource B<keysym>.
426		485
…		…
461	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
462	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
463	yourself if you want that.	522	yourself if you want that.
464		523
465	As an extremely special case, specifying C<-1> will completely suppress	524	As an extremely special case, specifying C<-1> will completely suppress
466	pty/tty operations.	525	pty/tty operations, which is probably only useful in conjunction with some
		526	perl extension that manages the terminal.
467		527
468	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
469	longer example is in F<doc/pty-fd>):	529	longer example is in F<doc/pty-fd>):
470		530
471	use IO::Pty;	531	use IO::Pty;
…		…
478		538
479	# now communicate with rxvt	539	# now communicate with rxvt
480	my $slave = $pty->slave;	540	my $slave = $pty->slave;
481	while (<$slave>) { print $slave "got <$_>\n" }	541	while (<$slave>) { print $slave "got <$_>\n" }
482		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
483	=item B<-pe> I<string>	560	=item B<-pe> I<string>
484		561
485	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
486	this terminal instance. See resource B<perl-ext> for details.	563	this terminal instance. See resource B<perl-ext> for details.
487		564
488	=back	565	=back
489		566
490	=head1 RESOURCES (available also as long-options)	567	=head1 RESOURCES
491		568
492	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	569	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493	options) compiled into your version.	570	options) compiled into your version. All resources are also available as
		571	long-options.
494		572
495	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
496	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
497	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	575	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498	with later settings overwriting earlier ones:	576	with later settings overwriting earlier ones:
499		577
500	1. system-wide app-defaults file, either locale-dependent OR global
501	2. app-defaults file in $XAPPLRESDIR	578	1. app-defaults file in $XAPPLRESDIR
		579	2. $HOME/.Xdefaults
502	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	580	3. RESOURCE_MANAGER property on root-window of screen 0
503	4. SCREEN_RESOURCES for the current screen	581	4. SCREEN_RESOURCES property on root-window of the current screen
504	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	582	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		583	6. resources specified via -xrm on the commandline
505		584
506	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
507	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
508	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
509	configured, while the class name B<URxvt> allows resources unique to	588	configured, while the class name B<URxvt> allows resources unique to
…		…
512	be used. Command-line arguments can be used to override resource	591	be used. Command-line arguments can be used to override resource
513	settings. The following resources are supported (you might want to	592	settings. The following resources are supported (you might want to
514	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
515	extensions not documented here):	594	extensions not documented here):
516		595
517	=over 4	596	=over
518		597
519	=item B<depth:> I<bitdepth>	598	=item B<depth:> I<bitdepth>
520		599
521	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;
522	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.
523		609
524	=item B<geometry:> I<geom>	610	=item B<geometry:> I<geom>
525		611
526	Create the window with the specified X window geometry [default 80x24];	612	Create the window with the specified X window geometry [default 80x24];
527	option B<-geometry>.	613	option B<-geometry>.
…		…
541	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
542	corresponds to low-intensity (normal) colours and 8-15 corresponds to	628	corresponds to low-intensity (normal) colours and 8-15 corresponds to
543	high-intensity (bold = bright foreground, blink = bright background)	629	high-intensity (bold = bright foreground, blink = bright background)
544	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,
545	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
546	names used are listed in the B<COLORS AND GRAPHICS> section.	632	names used are listed in the B<COLOURS AND GRAPHICS> section.
547		633
548	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
549	changed using an escape command (see @@RXVT_NAME@@(7)).	635	changed using an escape command (see @@RXVT_NAME@@(7)).
550		636
551	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
…		…
562	=item B<colorUL:> I<colour>	648	=item B<colorUL:> I<colour>
563		649
564	Use the specified colour to display underlined characters when the	650	Use the specified colour to display underlined characters when the
565	foreground colour is the default.	651	foreground colour is the default.
566		652
567	=item B<colorRV:> I<colour>
568
569	Use the specified colour as the background for reverse video
570	characters.
571
572	=item B<underlineColor:> I<colour>	653	=item B<underlineColor:> I<colour>
573		654
574	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
575	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.
576		667
577	=item B<cursorColor:> I<colour>	668	=item B<cursorColor:> I<colour>
578		669
579	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
580	foreground colour; option B<-cr>.	671	foreground colour; option B<-cr>.
…		…
587		678
588	=item B<reverseVideo:> I<boolean>	679	=item B<reverseVideo:> I<boolean>
589		680
590	B<True>: simulate reverse video by foreground and background colours;	681	B<True>: simulate reverse video by foreground and background colours;
591	option B<-rv>. B<False>: regular screen colours [default]; option	682	option B<-rv>. B<False>: regular screen colours [default]; option
592	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	683	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593		684
594	=item B<jumpScroll:> I<boolean>	685	=item B<jumpScroll:> I<boolean>
595		686
596	B<True>: specify that jump scrolling should be used. When scrolling	687	B<True>: specify that jump scrolling should be used. When receiving lots
597	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
598	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>.
599		694
600	=item B<inheritPixmap:> I<boolean>	695	=item B<skipScroll:> I<boolean>
601		696
602	B<True>: make the background inherit the parent windows' pixmap, giving	697	B<True>: (the default) specify that skip scrolling should be used. When
603	artificial transparency. B<False>: do not inherit the parent windows'	698	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604	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>.
605		702
606	I<Please note that transparency of any kind if completely unsupported by	703	B<False>: specify that everything is to be displayed, even
607	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>.
608		718
609	=item B<fading:> I<number>	719	=item B<fading:> I<number>
610		720
611	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>.
612		722
613	=item B<fadeColor:> I<colour>	723	=item B<fadeColor:> I<colour>
614		724
615	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
616	colour is black; option B<-fadecolor>.	726	colour is black; option B<-fadecolor>.
617		727
618	=item B<tintColor:> I<colour>	728	=item B<iconFile:> I<file>
619		729
620	Tint the transparent background pixmap with the given colour; option	730	Set the application icon pixmap; option B<-icon>.
621	B<-tint>.
622
623	=item B<shading:> I<number>
624
625	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
626	image in addition to tinting it.
627		731
628	=item B<scrollColor:> I<colour>	732	=item B<scrollColor:> I<colour>
629		733
630	Use the specified colour for the scrollbar [default #B2B2B2].	734	Use the specified colour for the scrollbar [default #B2B2B2].
631		735
…		…
636		740
637	=item B<borderColor:> I<colour>	741	=item B<borderColor:> I<colour>
638		742
639	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
640	and the text.	744	and the text.
641
642	=item B<backgroundPixmap:> I<file[;geom]>
643
644	Use the specified XPM file (note the `.xpm' extension is optional) for
645	the background and also optionally specify its scaling with a geometry
646	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
647	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
648	centre (percent). A scale of 0 displays the image with tiling. A scale
649	of 1 displays the image without any scaling. A scale of 2 to 9
650	specifies an integer number of images in that direction. No image will
651	be magnified beyond 10 times its original size. The maximum permitted
652	scale is 1000. [default 0x0+50+50]
653
654	=item B<path:> I<path>
655
656	Specify the colon-delimited search path for finding XPM files.
657		745
658	=item B<font:> I<fontlist>	746	=item B<font:> I<fontlist>
659		747
660	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
661	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
…		…
684	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
685	wide and 15 pixels high.	773	wide and 15 pixels high.
686		774
687	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
688	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
689	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
690	useful supplement.	778	useful supplement.
691		779
692	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
693	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
694	contains other characters, but we are not interested in them.	782	contains other characters, but we are not interested in them.
…		…
718	text font will being used for the given style.	806	text font will being used for the given style.
719		807
720	=item B<intensityStyles:> I<boolean>	808	=item B<intensityStyles:> I<boolean>
721		809
722	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>,
723	option B<-is>, the default), bold and italic font styles imply high	811	option B<-is>, the default), bold/blink font styles imply high
724	intensity foreground/background colours. Disabling this option (B<False>,	812	intensity foreground/background colours. Disabling this option (B<False>,
725	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
726	reachable.	814	reachable.
727		815
728	=item B<selectstyle:> I<mode>
729
730	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
731	xterm style with 2.20 old word selection, or anything else which gives
732	xterm style selection.
733
734	=item B<scrollstyle:> I<mode>
735
736	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737	the author's favourite.
738
739	=item B<title:> I<string>	816	=item B<title:> I<string>
740		817
741	Set window title string, the default title is the command-line	818	Set window title string, the default title is the command-line
742	specified after the B<-e> option, if any, otherwise the application	819	specified after the B<-e> option, if any, otherwise the application
743	name; option B<-title>.	820	name; option B<-title>.
…		…
751	=item B<mapAlert:> I<boolean>	828	=item B<mapAlert:> I<boolean>
752		829
753	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	830	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754	de-iconify (map) on receipt of a bell character [default].	831	de-iconify (map) on receipt of a bell character [default].
755		832
		833	=item B<urgentOnBell:> I<boolean>
		834
		835	B<True>: set the urgency hint for the wm on receipt of a bell character.
		836	B<False>: do not set the urgency hint [default].
		837
		838	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		839
756	=item B<visualBell:> I<boolean>	840	=item B<visualBell:> I<boolean>
757		841
758	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>.
759	B<False>: no visual bell [default]; option B<+vb>.	843	B<False>: no visual bell [default]; option B<+vb>.
760		844
…		…
762		846
763	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
764	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
765	[default]; option B<+ls>.	849	[default]; option B<+ls>.
766		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
767	=item B<utmpInhibit:> I<boolean>	856	=item B<utmpInhibit:> I<boolean>
768		857
769	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>;
770	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>
771	[default]; option B<+ut>.	860	[default]; option B<+ut>.
…		…
783	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	872	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784		873
785	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
786	every time you hit C<Print>.	875	every time you hit C<Print>.
787		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
788	=item B<scrollBar:> I<boolean>	886	=item B<scrollBar:> I<boolean>
789		887
790	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	888	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791	disable the scrollbar; option B<+sb>.	889	disable the scrollbar; option B<+sb>.
792		890
…		…
805	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
806	thumb with the pointer on middle button press/drag.	904	thumb with the pointer on middle button press/drag.
807		905
808	=item B<scrollTtyOutput:> I<boolean>	906	=item B<scrollTtyOutput:> I<boolean>
809		907
810	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>.
811	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
812	B<+si>.	910	B<-si>.
813		911
814	=item B<scrollWithBuffer:> I<boolean>	912	=item B<scrollWithBuffer:> I<boolean>
815		913
816	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.
817	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
818	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>.
819		918
820	=item B<scrollTtyKeypress:> I<boolean>	919	=item B<scrollTtyKeypress:> I<boolean>
821		920
822	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
823	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
824	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
825	bottom when a non-special key is pressed; option B<+sk>.	924	bottom when a non-special key is pressed; option B<+sk>.
826		925
827	=item B<saveLines:> I<number>	926	=item B<saveLines:> I<number>
828		927
829	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>.
830	resource is limited on most machines to 65535; option B<-sl>.
831		929
832	=item B<internalBorder:> I<number>	930	=item B<internalBorder:> I<number>
833		931
834	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;
835	option B<-b>.	933	option B<-b>.
…		…
854	=item B<termName:> I<termname>	952	=item B<termName:> I<termname>
855		953
856	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
857	variable; option B<-tn>.	955	variable; option B<-tn>.
858		956
859	=item B<linespace:> I<number>	957	=item B<lineSpace:> I<number>
860		958
861	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
862	the display [default 0]; option B<-lsp>.	960	the display [default 0]; option B<-lsp>.
863		961
864	=item B<meta8:> I<boolean>	962	=item B<meta8:> I<boolean>
…		…
878		976
879	=item B<cursorBlink:> I<boolean>	977	=item B<cursorBlink:> I<boolean>
880		978
881	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];
882	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>.
883		986
884	=item B<pointerBlank:> I<boolean>	987	=item B<pointerBlank:> I<boolean>
885		988
886	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
887	of seconds of inactivity. B<False>: the pointer is always visible	990	of seconds of inactivity. B<False>: the pointer is always visible
…		…
893		996
894	=item B<pointerColor2:> I<colour>	997	=item B<pointerColor2:> I<colour>
895		998
896	Mouse pointer background colour.	999	Mouse pointer background colour.
897		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
898	=item B<pointerBlankDelay:> I<number>	1007	=item B<pointerBlankDelay:> I<number>
899		1008
900	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
901	large number (e.g. C<987654321>) to effectively disable the timeout.	1010	large number (e.g. C<987654321>) to effectively disable the timeout.
902		1011
903	=item B<backspacekey:> I<string>	1012	=item B<backspacekey:> I<string>
904		1013
905	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>
906	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>
907	(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
908	escape sequence.	1017	escape sequence.
909		1018
910	=item B<deletekey:> I<string>	1019	=item B<deletekey:> I<string>
911		1020
…		…
916	=item B<cutchars:> I<string>	1025	=item B<cutchars:> I<string>
917		1026
918	The characters used as delimiters for double-click word selection	1027	The characters used as delimiters for double-click word selection
919	(whitespace delimiting is added automatically if resource is given).	1028	(whitespace delimiting is added automatically if resource is given).
920		1029
921	When the selection extension is in use (the default if compiled in, see	1030	When the perl selection extension is in use (the default if compiled
922	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1031	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923	will be created (if the resource exists, otherwise, no regex will be	1032	characters will be created (if the resource exists, otherwise, no regex
924	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.
925		1034
926	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
927	be used. If not specified, the built-in default is used:	1036	be used. If not specified, the built-in default is used:
928		1037
929	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1038	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
930		1039
931	=item B<preeditType:> I<style>	1040	=item B<preeditType:> I<style>
932		1041
933	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1042	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934		1043
935	=item B<inputMethod:> I<name>	1044	=item B<inputMethod:> I<name>
936		1045
937	I<name> of inputMethod to use; option B<-im>.	1046	I<name> of inputMethod to use; option B<-im>.
938		1047
…		…
956		1065
957	Change the meaning of triple-click selection with the left mouse	1066	Change the meaning of triple-click selection with the left mouse
958	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
959	the end of the logical line only; option B<-tcw>.	1068	the end of the logical line only; option B<-tcw>.
960		1069
		1070	=item B<disablePasteBrackets:> I<boolean>
		1071
		1072	Prevent emission of paste bracket sequences; option B<-dpb>.
		1073
961	=item B<insecure:> I<boolean>	1074	=item B<insecure:> I<boolean>
962		1075
963	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1076	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
964	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
965	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
966	through a mail client displaying mail bodies unfiltered or through	1079	through a mail client displaying mail bodies unfiltered or through
967	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
968	default. (Note that many other terminals, including xterm, have these	1081	default. (Note that many other terminals, including xterm, have these
…		…
986		1099
987	=item B<secondaryScreen:> I<boolean>	1100	=item B<secondaryScreen:> I<boolean>
988		1101
989	Turn on/off secondary screen (default enabled).	1102	Turn on/off secondary screen (default enabled).
990		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
991	=item B<secondaryScroll:> I<boolean>	1109	=item B<secondaryScroll:> I<boolean>
992		1110
993	Turn on/off secondary screen scroll (default enabled). If the this	1111	Turn on/off secondary screen scroll (default enabled). If this
994	option is enabled, scrolls on the secondary screen will change the	1112	option is enabled, scrolls on the secondary screen will change the
995	scrollback buffer and switching to/from the secondary screen will	1113	scrollback buffer and, when secondaryScreen is off, switching
996	instead scroll the screen up.	1114	to/from the secondary screen will instead scroll the screen up.
997		1115
998	=item B<hold>: I<boolean>	1116	=item B<hold>: I<boolean>
999		1117
1000	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@@
1001	will not immediately destroy its window when the program executed within	1119	will not immediately destroy its window when the program executed within
1002	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
1003	user.	1121	user.
1004		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
1005	=item B<keysym.>I<sym>: I<string>	1130	=item B<keysym.>I<sym>: I<action>
1006		1131
1007	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1132	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1008	intervening resource name B<keysym.> cannot be omitted.	1133	resource name B<keysym.> cannot be omitted.
1009		1134
1010	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
1011	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1136	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1012	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
1013	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
1014	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
1015		1164
1016	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
1017	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
1018	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
1019	current application keymap mode state.	1168	current application keymap mode state.
1020		1169
1021	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
1022	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
1023	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
1024	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1182	value (B<0x0000 - 0xFFFF>).
1025	performed in an exact manner; however, the closest match is assured.
1026		1183
1027	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
1028	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
1029	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1186	number), see RESOURCES in C<man 7 X> for further details.
1030	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031	can start or end with whitespace. B<This feature is deprecated and will
1032	be removed>.
1033		1187
1034	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
1035	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
1036	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
1037	processing).	1191	prefixed with C<string:>).
1038		1192
1039	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
1040	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
1041	should be a character not used by the strings.	1212	the delimiter `/' should be a character not used by the strings.
1042		1213
1043	Its usage can be demonstrated by an example:	1214	Its usage can be demonstrated by an example:
1044		1215
1045	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>	1216	URxvt.keysym.M-C-0x61: list|\033<|abc|>
1046		1217
1047	The above line is equivalent to the following three lines:	1218	The above line is equivalent to the following three lines:
1048		1219
1049	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1220	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1050	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1221	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1051	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1222	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1052		1223
		1224	=item command:STRING
		1225
1053	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>
1054	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
1055	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>
1056	when Control-Meta-c is being pressed":	1233	when Control-Meta-c is being pressed":
1057		1234
1058	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
1059		1236
1060	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
1061	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
1062	manpage. For example, the F<selection> extension (activated via	1239	font-switching at runtime:
1063	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1064		1240
1065	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
1066		1243
1067	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
1068	will match if at I<at least> the specified identifiers are being set, and	1245	info):
1069	no other key mappings with those and more bits are being defined. That
1070	means that defining a key map for C<a> will automatically provide
1071	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1072	mappings themselves.
1073		1246
1074	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
1075	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
1076	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
1077	user-defined keymap using the C<builtin:> replacement:	1259	"holes" into the user-defined keymap using the C<builtin:> replacement:
1078		1260
1079	URxvt.keysym.Insert: <my insert key sequence>	1261	URxvt.keysym.Insert: <my insert key sequence>
1080	URxvt.keysym.S-Insert: builtin:	1262	URxvt.keysym.S-Insert: builtin:
1081		1263
1082	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
1083	of modifiers. The second line re-establishes the default mapping for	1265	of modifiers. The second line re-establishes the default mapping for
1084	C<Shift-Insert>.	1266	C<Shift-Insert>.
1085		1267
1086	The following example will map Control-Meta-1 and Control-Meta-2 to	1268	=item builtin-string:
1087	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1088	font-switching at runtime:
1089		1269
1090	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1270	This action is mainly useful to restore string mappings for keys that
1091	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.
1092		1275
1093	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
1094	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:
1095		1280
1096	URxvt.keysym.M-C-3: command:\033[8;25;80t	1281	URxvt.keysym.S-Insert: builtin-string:
1097	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
1098		1318
1099	=item B<perl-ext-common>: I<string>	1319	=item B<perl-ext-common>: I<string>
1100		1320
1101	=item B<perl-ext>: I<string>	1321	=item B<perl-ext>: I<string>
1102		1322
1103	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
1104	use in this terminal instance; option B<-pe>.	1324	use in this terminal instance; option B<-pe>.
1105		1325
1106	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
1107	them. This can be useful to selectively disable some extensions loaded	1327	case they had been specified earlier. This can be useful to selectively
1108	by default, or specified via the C<perl-ext-common> resource. For	1328	disable some extensions loaded by default, or specified via the
1109	example, C<default,-selection> will use all the default extension except	1329	C<perl-ext-common> resource. For example, C<default,-selection> will use
1110	C<selection>.	1330	all the default extensions except C<selection>.
1111		1331
1112	Extension names can also be followed by an argument in angle brackets	1332	To prohibit autoloading of extensions, you can prefix them with C</>,
1113	(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
1114	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1334	overridden, however, by specifying the extension name again without a
1115	multiple times with different arguments will pass multiple arguments to	1335	prefix, though). This does not prohibit extensions themselves loading
1116	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>.
1117		1347
1118	Each extension is looked up in the library directories, loaded if	1348	Each extension is looked up in the library directories, loaded if
1119	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.
1120		1352
1121	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
1122	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
1123	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
1124	all instances, while B<perl-ext> is used for specific instances.	1356	all instances, while B<perl-ext> is used for specific instances.
1125		1357
1126	=item B<perl-eval>: I<string>	1358	=item B<perl-eval>: I<string>
1127		1359
1128	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
1129	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1361	the @@RXVT_NAME@@perl(3) manpage.
1130	will be ignored when running setuid/setgid.
1131		1362
1132	=item B<perl-lib>: I<path>	1363	=item B<perl-lib>: I<path>
1133		1364
1134	Colon-separated list of additional directories that hold extension	1365	Colon-separated list of additional directories that hold extension
1135	scripts. When looking for extensions specified by the C<perl> resource,	1366	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1136	@@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
1137	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1368	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1138	will be ignored when running setuid/setgid.
1139		1369
1140	See the @@RXVT_NAME@@perl(3) manpage.	1370	See the @@RXVT_NAME@@perl(3) manpage.
1141		1371
1142	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1372	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1143		1373
…		…
1147	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1377	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1148		1378
1149	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1379	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1150	for details.	1380	for details.
1151		1381
1152	=item B<searchable-scrollback:> I<keysym>	1382	=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1153		1383
1154	Sets the hotkey that starts the incremental scrollback buffer search	1384	This resource is deprecated and will be removed. Use a B<keysym> resource
1155	(default: C<M-s>).	1385	instead, e.g.:
1156		1386
		1387	URxvt.keysym.M-s: searchable-scrollback:start
		1388
1157	=item B<urlLauncher>: I<string>	1389	=item B<url-launcher>: I<string>
1158		1390
1159	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
1160	C<selection-popup> and C<mark-urls> perl extensions.	1392	C<selection-popup> and C<matcher> perl extensions.
1161		1393
1162	=item B<transient-for>: I<windowid>	1394	=item B<transient-for>: I<windowid>
1163		1395
1164	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1396	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1165		1397
1166	=item B<override-redirect>: I<boolean>	1398	=item B<override-redirect>: I<boolean>
1167		1399
1168	Compile I<frills>: Sets override-redirect for the terminal window, making	1400	Compile I<frills>: Sets override-redirect for the terminal window, making
1169	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).
		1406
		1407	=item B<iso14755_52:> I<boolean>
		1408
		1409	Turn on/off ISO 14755 5.2 mode (default enabled).
1170		1410
1171	=back	1411	=back
1172		1412
1173	=head1 THE SCROLLBAR	1413	=head1 THE SCROLLBAR
1174		1414
…		…
1193	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1433	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1194	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1434	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1195	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1435	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1196	respectively.	1436	respectively.
1197		1437
1198	=head1 TEXT SELECTION AND INSERTION	1438	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1199		1439
1200	The behaviour of text selection and insertion mechanism is similar to	1440	The behaviour of text selection and insertion/pasting mechanism is similar
1201	I<xterm>(1).	1441	to I<xterm>(1).
1202		1442
1203	=over 4	1443	=over
1204		1444
1205	=item B<Selection>:	1445	=item B<Selecting>:
1206		1446
1207	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
1208	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
1209	to select a word; Left triple-click to select the entire logical line	1449	to select a word; Left triple-click to select the entire logical line
1210	(which can span multiple screen lines), unless modified by resource	1450	(which can span multiple screen lines), unless modified by resource
…		…
1214	(Compile: I<frills>) will create a rectangular selection instead of a	1454	(Compile: I<frills>) will create a rectangular selection instead of a
1215	normal one. In this mode, every selected row becomes its own line in the	1455	normal one. In this mode, every selected row becomes its own line in the
1216	selection, and trailing whitespace is visually underlined and removed from	1456	selection, and trailing whitespace is visually underlined and removed from
1217	the selection.	1457	the selection.
1218		1458
1219	=item B<Insertion>:	1459	=item B<Pasting>:
1220		1460
1221	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1461	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1222	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1462	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1223	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.
1224		1464
1225	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
1226	inserted too.	1466	inserted too.
1227		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
1228	=back	1474	=back
1229		1475
1230	=head1 CHANGING FONTS	1476	=head1 CHANGING FONTS
1231		1477
1232	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
…		…
1245		1491
1246	=head1 ISO 14755 SUPPORT	1492	=head1 ISO 14755 SUPPORT
1247		1493
1248	ISO 14755 is a standard for entering and viewing unicode characters	1494	ISO 14755 is a standard for entering and viewing unicode characters
1249	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
1250	first part is available rxvt-unicode has been compiled with	1496	first part is available if rxvt-unicode has been compiled with
1251	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
1252	with C<--enable-iso14755>.	1498	with C<--enable-iso14755>.
1253		1499
1254	=over 4	1500	=over
1255		1501
1256	=item * 5.1: Basic method	1502	=item * 5.1: Basic method
1257		1503
1258	This allows you to enter unicode characters using their hexcode.	1504	This allows you to enter unicode characters using their hexcode.
1259		1505
…		…
1313	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
1314	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
1315	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
1316	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.
1317		1563
1318	=head1 COLORS AND GRAPHICS	1564	=head1 COLOURS AND GRAPHICS
1319		1565
1320	In addition to the default foreground and background colours,	1566	In addition to the default foreground and background colours,
1321	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
1322	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
1323	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.
1324		1582
1325	=begin table	1583	=begin table
1326		1584
1327	B<color0> (black) = Black	1585	B<color0> (black) = Black
1328	B<color1> (red) = Red3	1586	B<color1> (red) = Red3
…		…
1348	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>,
1349	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1607	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1350	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
1351	color0-color15.	1609	color0-color15.
1352		1610
1353	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1611	The following text gives values for the standard 88 colour mode (and
1354	additional 72 colours. The first 64 of those (with indices 16 to 79)	1612	values for the 256 colour mode in parentheses).
1355	consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1356	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1357		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
1358	Together, all those colours implement the 88 colour xterm colours. Only	1623	Together, all those colours implement the 88 (256) colour xterm
1359	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
1360	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...).
1361		1629
1362	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1630	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1363	always swapping the foreground/background colours. This is in contrast to	1631	always swapping the foreground/background colours. This is in contrast to
1364	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
1365	been specified. For example,	1633	been specified. For example,
1366		1634
1367	=over 4
1368
1369	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1635	@@RXVT_NAME@@ -fg Black -bg White -rv
1370		1636
1371	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
1372	on White.	1638	White.
1373
1374	=back
1375		1639
1376	=head2 ALPHA CHANNEL SUPPORT	1640	=head2 ALPHA CHANNEL SUPPORT
1377		1641
1378	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
1379	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:
1380	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1644
1381	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
1382	specifies opacity (alpha) values. The minimum value of C<0> is completely	1656	(alpha) values. The minimum value of C<0000> is completely transparent,
1383	transparent). You can also prefix any color with C<[a]>, where C<a> is on	1657	while C<ffff> is completely opaque). The two example colours from
1384	to four hex digits specifiying the opacity value.	1658	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1659	C<rgba:0000/ff00/0000/f332>.
1385		1660
1386	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
1387	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
1388	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.
1389		1665
1390	For example, the following selects an almost completely transparent red	1666	For example, the following selects an almost completely transparent black
1391	background, and an almost opaque pink foreground:	1667	background, and an almost opaque pink foreground:
1392		1668
1393	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"	1669	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1394		1670
1395	I<Please note that transparency of any kind if completely unsupported by	1671	When not using a background image, then the interpretation of the
1396	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.
1397		1685
1398	=head1 ENVIRONMENT	1686	=head1 ENVIRONMENT
1399		1687
1400	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1688	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1401		1689
1402	=over 4	1690	=over
1403		1691
1404	=item B<TERM>	1692	=item B<TERM>
1405		1693
1406	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
1407	resources or on the command line.	1695	resources or on the command line.
1408		1696
1409	=item B<COLORTERM>	1697	=item B<COLORTERM>
1410		1698
1411	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
1412	compiled with XPM support, and optionally with the added extension	1700	compiled with background image support, and optionally with the added
1413	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.
1414		1703
1415	=item B<COLORFGBG>	1704	=item B<COLORFGBG>
1416		1705
1417	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
1418	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
1419	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
1420	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
1421	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@@
1422	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1711	was compiled with background image support. Libraries like C<ncurses>
1423	(and do) use this information to optimize screen output.	1712	and C<slang> can (and do) use this information to optimize screen output.
1424		1713
1425	=item B<WINDOWID>	1714	=item B<WINDOWID>
1426		1715
1427	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
1428	window, which usually has subwindows for the scrollbar, the terminal	1717	window, which usually has subwindows for the scrollbar, the terminal
…		…
1434	C<--with-terminfo=PATH>.	1723	C<--with-terminfo=PATH>.
1435		1724
1436	=item B<DISPLAY>	1725	=item B<DISPLAY>
1437		1726
1438	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
1439	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.
1440		1730
1441	=item B<SHELL>	1731	=item B<SHELL>
1442		1732
1443	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>.
1444		1734
1445	=item B<RXVT_SOCKET>	1735	=item B<RXVT_SOCKET> [I<sic>]
1446		1736
1447	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
1448	@@RXVT_NAME@@d(1).	1738	@@RXVT_NAME@@d(1).
1449		1739
1450	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).
1451		1751
1452	=item B<HOME>	1752	=item B<HOME>
1453		1753
1454	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
1455	daemon communications and to locate various resource files (such as	1755	daemon communications and to locate various resource files (such as
1456	C<.Xdefaults>)	1756	C<.Xdefaults>)
1457		1757
1458	=item B<XAPPLRESDIR>	1758	=item B<XAPPLRESDIR>
1459		1759
1460	Directory where various X resource files are being located.	1760	Directory where application-specific X resource files are located.
1461		1761
1462	=item B<XENVIRONMENT>	1762	=item B<XENVIRONMENT>
1463		1763
1464	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
1465	@@RXVT_NAME@@.	1765	@@RXVT_NAME@@.
1466		1766
1467	=back	1767	=back
1468		1768
1469	=head1 FILES	1769	=head1 FILES
1470		1770
1471	=over 4	1771	=over
1472		1772
1473	=item B</usr/lib/X11/rgb.txt>	1773	=item B</usr/lib/X11/rgb.txt>
1474		1774
1475	Color names.	1775	Colour names.
1476		1776
1477	=back	1777	=back
1478		1778
1479	=head1 SEE ALSO	1779	=head1 SEE ALSO
1480		1780
		1781	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1481	@@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)
1482		1783
1483	=head1 CURRENT PROJECT COORDINATOR	1784	=head1 CURRENT PROJECT COORDINATOR
1484		1785
1485	=over 4	1786	=over
1486		1787
1487	=item Project Coordinator	1788	=item Project Coordinator
1488		1789
1489	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1790	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1490		1791
1491	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1792	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1492		1793
1493	=back	1794	=back
1494		1795
1495	=head1 AUTHORS	1796	=head1 AUTHORS
1496		1797
1497	=over 4	1798	=over
1498		1799
1499	=item John Bovey	1800	=item John Bovey
1500		1801
1501	University of Kent, 1992, wrote the original Xvt.	1802	University of Kent, 1992, wrote the original Xvt.
1502		1803
1503	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1804	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1504		1805
1505	very heavily modified Xvt and came up with Rxvt	1806	very heavily modified Xvt and came up with Rxvt
1506		1807
1507	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1808	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1508		1809
1509	wrote the Greek Keyboard Input (no longer in code)	1810	wrote the Greek Keyboard Input (no longer in code)
1510		1811
1511	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1812	=item mj olesen <olesen@me.QueensU.CA>
1512		1813
1513	Wrote the menu system.	1814	Wrote the menu system.
1514		1815
1515	Project Coordinator (changes.txt 2.11 to 2.21)	1816	Project Coordinator (changes.txt 2.11 to 2.21)
1516		1817
1517	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1818	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1518		1819
1519	Project Coordinator (changes.txt 2.21a to 2.4.5)	1820	Project Coordinator (changes.txt 2.21a to 2.4.5)
1520		1821
1521	=item Geoff Wing L<< <gcw@pobox.com> >>	1822	=item Geoff Wing <gcw@pobox.com>
1522		1823
1523	Rewrote screen display and text selection routines.	1824	Rewrote screen display and text selection routines.
1524		1825
1525	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1826	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1526		1827
1527	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1828	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1528		1829
1529	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1830	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1530	extension, random hacks, numerous bugfixes and extensions.	1831	extension, random hacks, numerous bugfixes and extensions.
1531		1832
1532	Project Coordinator (Changes 1.0 -)	1833	Project Coordinator (Changes 1.0 -)
1533		1834
1534	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1835	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1535		1836
1536	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1837	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1537		1838
1538	=back	1839	=back
1539		1840

Diff Legend

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