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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC vs. Revision 1.255 by root, Sat Jul 24 11:00:58 2021 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC vs.
Revision 1.255 by root, Sat Jul 24 11:00:58 2021 UTC