[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs.
Revision 1.259 by sf-exg, Sun Dec 19 20:48:21 2021 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs. Revision 1.259 by sf-exg, Sun Dec 19 20:48:21 2021 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs.
Revision 1.259 by sf-exg, Sun Dec 19 20:48:21 2021 UTC