[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.239 by sf-exg, Sun Oct 12 20:51:51 2014 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
…		…
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 possible
		114	visual ids).
		115
103	=item B<-geometry> I<geom>	116	=item B<-geometry> I<geom>
104		117
105	Window geometry (B<-g> still respected); resource B<geometry>.	118	Window geometry (B<-g> still respected); resource B<geometry>.
106		119
107	=item B<-rv>\|B<+rv>	120	=item B<-rv>\|B<+rv>
108		121
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	122	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		123
111	=item B<-j>\|B<+j>	124	=item B<-j>\|B<+j>
112		125
113	Turn on/off jump scrolling; resource B<jumpScroll>.	126	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		127
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	128	=item B<-ss>\|B<+ss>
116		129
117	Turn on/off inheriting parent window's pixmap. Alternative form is	130	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		131
124	=item B<-fade> I<number>	132	=item B<-fade> I<number>
125		133
126	Fade the text by the given percentage when focus is lost. Small values	134	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	135	fade a little only, 100 completely replaces all colours by the fade
…		…
130	=item B<-fadecolor> I<colour>	138	=item B<-fadecolor> I<colour>
131		139
132	Fade to this colour when fading is used (see B<-fade>). The default colour	140	Fade to this colour when fading is used (see B<-fade>). The default colour
133	is opaque black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
134		142
135	=item B<-tint> I<colour>	143	=item B<-icon> I<file>
136		144
137	Tint the transparent background pixmap with the given colour when	145	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	146	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	147	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		148
166	=item B<-bg> I<colour>	149	=item B<-bg> I<colour>
167		150
168	Window background colour; resource B<background>.	151	Window background colour; resource B<background>.
169		152
170	=item B<-fg> I<colour>	153	=item B<-fg> I<colour>
171		154
172	Window foreground colour; resource B<foreground>.	155	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		156
181	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
182		158
183	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
184		160
…		…
229	italic> >> characters are to be printed. See resource B<boldItalicFont>	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
230	for details.	206	for details.
231		207
232	=item B<-is>\|B<+is>	208	=item B<-is>\|B<+is>
233		209
234	Compile I<font-styles>: Bold/Italic font styles imply high intensity	210	Compile I<font-styles>: Bold/Blink font styles imply high intensity
235	foreground/background (default). See resource B<intensityStyles> for	211	foreground/background (default). See resource B<intensityStyles> for
236	details.	212	details.
237		213
238	=item B<-name> I<name>	214	=item B<-name> I<name>
239		215
…		…
243		219
244	=item B<-ls>\|B<+ls>	220	=item B<-ls>\|B<+ls>
245		221
246	Start as a login-shell/sub-shell; resource B<loginShell>.	222	Start as a login-shell/sub-shell; resource B<loginShell>.
247		223
		224	=item B<-mc> I<milliseconds>
		225
		226	Specify the maximum time between multi-click selections.
		227
248	=item B<-ut>\|B<+ut>	228	=item B<-ut>\|B<+ut>
249		229
250	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	230	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
251	B<utmpInhibit>.	231	B<utmpInhibit>.
252		232
…		…
256	B<visualBell>.	236	B<visualBell>.
257		237
258	=item B<-sb>\|B<+sb>	238	=item B<-sb>\|B<+sb>
259		239
260	Turn on/off scrollbar; resource B<scrollBar>.	240	Turn on/off scrollbar; resource B<scrollBar>.
		241
		242	=item B<-sr>\|B<+sr>
		243
		244	Put scrollbar on right/left; resource B<scrollBar_right>.
		245
		246	=item B<-st>\|B<+st>
		247
		248	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		249	resource B<scrollBar_floating>.
261		250
262	=item B<-si>\|B<+si>	251	=item B<-si>\|B<+si>
263		252
264	Turn on/off scroll-to-bottom on TTY output inhibit; resource	253	Turn on/off scroll-to-bottom on TTY output inhibit; resource
265	B<scrollTtyOutput> has opposite effect.	254	B<scrollTtyOutput> has opposite effect.
…		…
272	=item B<-sw>\|B<+sw>	261	=item B<-sw>\|B<+sw>
273		262
274	Turn on/off scrolling with the scrollback buffer as new lines appear.	263	Turn on/off scrolling with the scrollback buffer as new lines appear.
275	This only takes effect if B<-si> is also given; resource	264	This only takes effect if B<-si> is also given; resource
276	B<scrollWithBuffer>.	265	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		266
287	=item B<-ptab>\|B<+ptab>	267	=item B<-ptab>\|B<+ptab>
288		268
289	If enabled (default), "Horizontal Tab" characters are being stored as	269	If enabled (default), "Horizontal Tab" characters are being stored as
290	actual wide characters in the screen buffer, which makes it possible to	270	actual wide characters in the screen buffer, which makes it possible to
…		…
294		274
295	=item B<-bc>\|B<+bc>	275	=item B<-bc>\|B<+bc>
296		276
297	Blink the cursor; resource B<cursorBlink>.	277	Blink the cursor; resource B<cursorBlink>.
298		278
		279	=item B<-uc>\|B<+uc>
		280
		281	Make the cursor underlined; resource B<cursorUnderline>.
		282
299	=item B<-iconic>	283	=item B<-iconic>
300		284
301	Start iconified, if the window manager supports that option.	285	Start iconified, if the window manager supports that option.
302	Alternative form is B<-ic>.	286	Alternative form is B<-ic>.
303		287
…		…
319		303
320	=item B<-bl>	304	=item B<-bl>
321		305
322	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	306	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	307	if honoured by the WM, the rxvt-unicode window will not have window
324	decorations; resource B<borderLess>.	308	decorations; resource B<borderLess>. If the window manager does not
		309	support MWM hints (e.g. kwin), enables override-redirect mode.
325		310
326	=item B<-override-redirect>	311	=item B<-override-redirect>
327		312
328	Compile I<frills>: Sets override-redirect on the window; resource	313	Compile I<frills>: Sets override-redirect on the window; resource
329	B<override-redirect>.	314	B<override-redirect>.
		315
		316	=item B<-dockapp>
		317
		318	Sets the initial state of the window to WithdrawnState, which makes
		319	window managers that support this extension treat it as a dockapp.
330		320
331	=item B<-sbg>	321	=item B<-sbg>
332		322
333	Compile I<frills>: Disable the usage of the built-in block graphics/line	323	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	324	drawing characters and just rely on what the specified fonts provide. Use
…		…
337		327
338	=item B<-lsp> I<number>	328	=item B<-lsp> I<number>
339		329
340	Compile I<frills>: Lines (pixel height) to insert between each row of	330	Compile I<frills>: Lines (pixel height) to insert between each row of
341	the display. Useful to work around font rendering problems; resource	331	the display. Useful to work around font rendering problems; resource
342	B<linespace>.	332	B<lineSpace>.
		333
		334	=item B<-letsp> I<number>
		335
		336	Compile I<frills>: Amount to adjust the computed character width by
		337	to control overall letter spacing. Negative values will tighten up the
		338	letter spacing, positive values will space letters out more. Useful to
		339	work around odd font metrics; resource B<letterSpace>.
343		340
344	=item B<-tn> I<termname>	341	=item B<-tn> I<termname>
345		342
346	This option specifies the name of the terminal type to be set in the	343	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	344	B<TERM> environment variable. This terminal type must exist in the
…		…
402		399
403	=item B<-tcw>	400	=item B<-tcw>
404		401
405	Change the meaning of triple-click selection with the left mouse	402	Change the meaning of triple-click selection with the left mouse
406	button. Only effective when the original (non-perl) selection code is	403	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	404	in-use. Instead of selecting a full line it will extend the selection to
408	end of the logical line only. resource B<tripleclickwords>.	405	the end of the logical line only. resource B<tripleclickwords>.
409		406
410	=item B<-insecure>	407	=item B<-insecure>
411		408
412	Enable "insecure" mode, which currently enables most of the escape	409	Enable "insecure" mode, which currently enables most of the escape
413	sequences that echo strings. See the resource B<insecure> for more	410	sequences that echo strings. See the resource B<insecure> for more
…		…
433		430
434	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	431	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
435	will not immediately destroy its window when the program executed within	432	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	433	it exits. Instead, it will wait till it is being killed or closed by the
437	user; resource B<hold>.	434	user; resource B<hold>.
		435
		436	=item B<-cd> I<path>
		437
		438	Sets the working directory for the shell (or the command specified via
		439	B<-e>). The I<path> must be an absolute path and it must exist for
		440	@@RXVT_NAME@@ to start; resource B<chdir>.
		441
		442	=item B<-xrm> I<string>
		443
		444	Works like the X Toolkit option of the same name, by adding the I<string>
		445	as if it were specified in a resource file. Resource values specified this
		446	way take precedence over all other resource specifications.
		447
		448	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		449	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		450	options can be specified as long-options on the commandline, so use
		451	of B<-xrm> is mostly limited to cases where you want to specify other
		452	resources (e.g. for input methods) or for compatibility with other
		453	programs.
438		454
439	=item B<-keysym.>I<sym> I<string>	455	=item B<-keysym.>I<sym> I<string>
440		456
441	Remap a key symbol. See resource B<keysym>.	457	Remap a key symbol. See resource B<keysym>.
442		458
…		…
477	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	493	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	494	entries and will not tinker with pty/tty permissions - you have to do that
479	yourself if you want that.	495	yourself if you want that.
480		496
481	As an extremely special case, specifying C<-1> will completely suppress	497	As an extremely special case, specifying C<-1> will completely suppress
482	pty/tty operations.	498	pty/tty operations, which is probably only useful in conjunction with some
		499	perl extension that manages the terminal.
483		500
484	Here is a example in perl that illustrates how this option can be used (a	501	Here is a example in perl that illustrates how this option can be used (a
485	longer example is in F<doc/pty-fd>):	502	longer example is in F<doc/pty-fd>):
486		503
487	use IO::Pty;	504	use IO::Pty;
…		…
501	Comma-separated list of perl extension scripts to use (or not to use) in	518	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.	519	this terminal instance. See resource B<perl-ext> for details.
503		520
504	=back	521	=back
505		522
506	=head1 RESOURCES (available also as long-options)	523	=head1 RESOURCES
507		524
508	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	525	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
509	options) compiled into your version.	526	options) compiled into your version. All resources are also available as
		527	long-options.
510		528
511	You can set and change the resources using X11 tools like B<xrdb>. Many	529	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	530	distribution do also load settings from the B<~/.Xresources> file when X
513	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	531	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
514	with later settings overwriting earlier ones:	532	with later settings overwriting earlier ones:
515		533
516	1. system-wide app-defaults file, either locale-dependent OR global
517	2. app-defaults file in $XAPPLRESDIR	534	1. app-defaults file in $XAPPLRESDIR
		535	2. $HOME/.Xdefaults
518	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	536	3. RESOURCE_MANAGER property on root-window of screen 0
519	4. SCREEN_RESOURCES for the current screen	537	4. SCREEN_RESOURCES property on root-window of the current screen
520	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	538	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		539	6. resources specified via -xrm on the commandline
521		540
522	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	541	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	542	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	543	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	544	configured, while the class name B<URxvt> allows resources unique to
…		…
535	=item B<depth:> I<bitdepth>	554	=item B<depth:> I<bitdepth>
536		555
537	Compile I<xft>: Attempt to find a visual with the given bit depth;	556	Compile I<xft>: Attempt to find a visual with the given bit depth;
538	option B<-depth>.	557	option B<-depth>.
539		558
		559	=item B<buffered:> I<boolean>
		560
		561	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		562	On some card/driver combination enabling it slightly decreases
		563	performance, on most it greatly helps it. The slowdown is small, so it
		564	should normally be enabled.
		565
540	=item B<geometry:> I<geom>	566	=item B<geometry:> I<geom>
541		567
542	Create the window with the specified X window geometry [default 80x24];	568	Create the window with the specified X window geometry [default 80x24];
543	option B<-geometry>.	569	option B<-geometry>.
544		570
…		…
557	Use the specified colour for the colour value I<n>, where 0-7	583	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	584	corresponds to low-intensity (normal) colours and 8-15 corresponds to
559	high-intensity (bold = bright foreground, blink = bright background)	585	high-intensity (bold = bright foreground, blink = bright background)
560	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	586	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	587	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.	588	names used are listed in the B<COLOURS AND GRAPHICS> section.
563		589
564	Colours higher than 15 cannot be set using resources (yet), but can be	590	Colours higher than 15 cannot be set using resources (yet), but can be
565	changed using an escape command (see @@RXVT_NAME@@(7)).	591	changed using an escape command (see @@RXVT_NAME@@(7)).
566		592
567	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	593	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
578	=item B<colorUL:> I<colour>	604	=item B<colorUL:> I<colour>
579		605
580	Use the specified colour to display underlined characters when the	606	Use the specified colour to display underlined characters when the
581	foreground colour is the default.	607	foreground colour is the default.
582		608
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>	609	=item B<underlineColor:> I<colour>
589		610
590	If set, use the specified colour as the colour for the underline	611	If set, use the specified colour as the colour for the underline
591	itself. If unset, use the foreground colour.	612	itself. If unset, use the foreground colour.
		613
		614	=item B<highlightColor:> I<colour>
		615
		616	If set, use the specified colour as the background for highlighted
		617	characters. If unset, use reverse video.
		618
		619	=item B<highlightTextColor:> I<colour>
		620
		621	If set and highlightColor is set, use the specified colour as the
		622	foreground for highlighted characters.
592		623
593	=item B<cursorColor:> I<colour>	624	=item B<cursorColor:> I<colour>
594		625
595	Use the specified colour for the cursor. The default is to use the	626	Use the specified colour for the cursor. The default is to use the
596	foreground colour; option B<-cr>.	627	foreground colour; option B<-cr>.
…		…
603		634
604	=item B<reverseVideo:> I<boolean>	635	=item B<reverseVideo:> I<boolean>
605		636
606	B<True>: simulate reverse video by foreground and background colours;	637	B<True>: simulate reverse video by foreground and background colours;
607	option B<-rv>. B<False>: regular screen colours [default]; option	638	option B<-rv>. B<False>: regular screen colours [default]; option
608	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	639	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
609		640
610	=item B<jumpScroll:> I<boolean>	641	=item B<jumpScroll:> I<boolean>
611		642
612	B<True>: specify that jump scrolling should be used. When scrolling	643	B<True>: specify that jump scrolling should be used. When receiving lots
613	quickly, fewer screen updates are performed [default]; option B<-j>.	644	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		645	has been read, resulting in fewer updates while still displaying every
		646	received line; option B<-j>.
		647
614	B<False>: specify that smooth scrolling should be used; option B<+j>.	648	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		649	force a screen refresh on each new line it received; option B<+j>.
615		650
616	=item B<inheritPixmap:> I<boolean>	651	=item B<skipScroll:> I<boolean>
617		652
618	B<True>: make the background inherit the parent windows' pixmap, giving	653	B<True>: (the default) specify that skip scrolling should be used. When
619	artificial transparency. B<False>: do not inherit the parent windows'	654	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
620	pixmap.	655	(around 60 times per second), resulting in far fewer updates. This can
		656	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		657	option B<-ss>.
621		658
622	I<Please note that transparency of any kind if completely unsupported by	659	B<False>: specify that everything is to be displayed, even
623	the author. Don't bug him with installation questions!>	660	if the refresh is too fast for the human eye to read anything (or the
		661	monitor to display anything); option B<+ss>.
624		662
625	=item B<fading:> I<number>	663	=item B<fading:> I<number>
626		664
627	Fade the text by the given percentage when focus is lost; option B<-fade>.	665	Fade the text by the given percentage when focus is lost; option B<-fade>.
628		666
629	=item B<fadeColor:> I<colour>	667	=item B<fadeColor:> I<colour>
630		668
631	Fade to this colour, when fading is used (see B<fading:>). The default	669	Fade to this colour, when fading is used (see B<fading:>). The default
632	colour is black; option B<-fadecolor>.	670	colour is black; option B<-fadecolor>.
633		671
634	=item B<tintColor:> I<colour>	672	=item B<iconFile:> I<file>
635		673
636	Tint the transparent background pixmap with the given colour; option	674	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		675
653	=item B<scrollColor:> I<colour>	676	=item B<scrollColor:> I<colour>
654		677
655	Use the specified colour for the scrollbar [default #B2B2B2].	678	Use the specified colour for the scrollbar [default #B2B2B2].
656		679
…		…
661		684
662	=item B<borderColor:> I<colour>	685	=item B<borderColor:> I<colour>
663		686
664	The colour of the border around the text area and between the scrollbar	687	The colour of the border around the text area and between the scrollbar
665	and the text.	688	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		689
688	=item B<font:> I<fontlist>	690	=item B<font:> I<fontlist>
689		691
690	Select the fonts to be used. This is a comma separated list of font names	692	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	693	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	716	it is named first) and thus defines the character cell grid to be 9 pixels
715	wide and 15 pixels high.	717	wide and 15 pixels high.
716		718
717	The second font is just used to add additional unicode characters not in	719	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	720	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	721	the bold version of the font does contain fewer characters, so this is a
720	useful supplement.	722	useful supplement.
721		723
722	The third font is an Xft font with aliasing turned off, and the characters	724	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	725	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.	726	contains other characters, but we are not interested in them.
…		…
748	text font will being used for the given style.	750	text font will being used for the given style.
749		751
750	=item B<intensityStyles:> I<boolean>	752	=item B<intensityStyles:> I<boolean>
751		753
752	When font styles are not enabled, or this option is enabled (B<True>,	754	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	755	option B<-is>, the default), bold/blink font styles imply high
754	intensity foreground/background colours. Disabling this option (B<False>,	756	intensity foreground/background colours. Disabling this option (B<False>,
755	option B<+is>) disables this behaviour, the high intensity colours are not	757	option B<+is>) disables this behaviour, the high intensity colours are not
756	reachable.	758	reachable.
757		759
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>	760	=item B<title:> I<string>
771		761
772	Set window title string, the default title is the command-line	762	Set window title string, the default title is the command-line
773	specified after the B<-e> option, if any, otherwise the application	763	specified after the B<-e> option, if any, otherwise the application
774	name; option B<-title>.	764	name; option B<-title>.
…		…
787	=item B<urgentOnBell:> I<boolean>	777	=item B<urgentOnBell:> I<boolean>
788		778
789	B<True>: set the urgency hint for the wm on receipt of a bell character.	779	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].	780	B<False>: do not set the urgency hint [default].
791		781
		782	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		783
792	=item B<visualBell:> I<boolean>	784	=item B<visualBell:> I<boolean>
793		785
794	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	786	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
795	B<False>: no visual bell [default]; option B<+vb>.	787	B<False>: no visual bell [default]; option B<+vb>.
796		788
…		…
798		790
799	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	791	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	792	the shell; option B<-ls>. B<False>: start as a normal sub-shell
801	[default]; option B<+ls>.	793	[default]; option B<+ls>.
802		794
		795	=item B<multiClickTime:> I<number>
		796
		797	Specify the maximum time in milliseconds between multi-click select
		798	events. The default is 500 milliseconds; option B<-mc>.
		799
803	=item B<utmpInhibit:> I<boolean>	800	=item B<utmpInhibit:> I<boolean>
804		801
805	B<True>: inhibit writing record into the system log file B<utmp>;	802	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>	803	option B<-ut>. B<False>: write record into the system log file B<utmp>
807	[default]; option B<+ut>.	804	[default]; option B<+ut>.
…		…
819	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	816	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
820		817
821	This creates a new file in your home directory with the screen contents	818	This creates a new file in your home directory with the screen contents
822	every time you hit C<Print>.	819	every time you hit C<Print>.
823		820
		821	=item B<scrollstyle:> I<mode>
		822
		823	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		824	the author's favourite.
		825
		826	=item B<thickness:> I<number>
		827
		828	Set the scrollbar width in pixels.
		829
824	=item B<scrollBar:> I<boolean>	830	=item B<scrollBar:> I<boolean>
825		831
826	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	832	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
827	disable the scrollbar; option B<+sb>.	833	disable the scrollbar; option B<+sb>.
828		834
…		…
847	B<False>: do not scroll to bottom when tty receives output; option	853	B<False>: do not scroll to bottom when tty receives output; option
848	B<+si>.	854	B<+si>.
849		855
850	=item B<scrollWithBuffer:> I<boolean>	856	=item B<scrollWithBuffer:> I<boolean>
851		857
852	B<True>: scroll with scrollback buffer when tty receives new lines (and	858	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	859	try to show the same lines) and B<scrollTtyOutput> is False; option
854	with scrollback buffer when tty receives new lines; option B<+sw>.	860	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		861	new lines; option B<+sw>.
855		862
856	=item B<scrollTtyKeypress:> I<boolean>	863	=item B<scrollTtyKeypress:> I<boolean>
857		864
858	B<True>: scroll to bottom when a non-special key is pressed. Special keys	865	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	866	are those which are intercepted by rxvt-unicode for special handling and
…		…
890	=item B<termName:> I<termname>	897	=item B<termName:> I<termname>
891		898
892	Specifies the terminal type name to be set in the B<TERM> environment	899	Specifies the terminal type name to be set in the B<TERM> environment
893	variable; option B<-tn>.	900	variable; option B<-tn>.
894		901
895	=item B<linespace:> I<number>	902	=item B<lineSpace:> I<number>
896		903
897	Specifies number of lines (pixel height) to insert between each row of	904	Specifies number of lines (pixel height) to insert between each row of
898	the display [default 0]; option B<-lsp>.	905	the display [default 0]; option B<-lsp>.
899		906
900	=item B<meta8:> I<boolean>	907	=item B<meta8:> I<boolean>
…		…
914		921
915	=item B<cursorBlink:> I<boolean>	922	=item B<cursorBlink:> I<boolean>
916		923
917	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	924	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
918	option B<-bc>.	925	option B<-bc>.
		926
		927	=item B<cursorUnderline:> I<boolean>
		928
		929	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		930	option B<-uc>.
919		931
920	=item B<pointerBlank:> I<boolean>	932	=item B<pointerBlank:> I<boolean>
921		933
922	B<True>: blank the pointer when a key is pressed or after a set number	934	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	935	of seconds of inactivity. B<False>: the pointer is always visible
…		…
937	large number (e.g. C<987654321>) to effectively disable the timeout.	949	large number (e.g. C<987654321>) to effectively disable the timeout.
938		950
939	=item B<backspacekey:> I<string>	951	=item B<backspacekey:> I<string>
940		952
941	The string to send when the backspace key is pressed. If set to B<DEC>	953	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>	954	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	955	(code 8) - which can be reversed with the appropriate DEC private mode
944	escape sequence.	956	escape sequence.
945		957
946	=item B<deletekey:> I<string>	958	=item B<deletekey:> I<string>
947		959
…		…
960	will be created). In this mode, characters outside ISO-8859-1 can be used.	972	will be created). In this mode, characters outside ISO-8859-1 can be used.
961		973
962	When the selection extension is not used, only ISO-8859-1 characters can	974	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:	975	be used. If not specified, the built-in default is used:
964		976
965	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	977	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
966		978
967	=item B<preeditType:> I<style>	979	=item B<preeditType:> I<style>
968		980
969	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	981	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
970		982
…		…
1026		1038
1027	=item B<secondaryScroll:> I<boolean>	1039	=item B<secondaryScroll:> I<boolean>
1028		1040
1029	Turn on/off secondary screen scroll (default enabled). If this	1041	Turn on/off secondary screen scroll (default enabled). If this
1030	option is enabled, scrolls on the secondary screen will change the	1042	option is enabled, scrolls on the secondary screen will change the
1031	scrollback buffer and switching to/from the secondary screen will	1043	scrollback buffer and, when secondaryScreen is off, switching
1032	instead scroll the screen up.	1044	to/from the secondary screen will instead scroll the screen up.
1033		1045
1034	=item B<hold>: I<boolean>	1046	=item B<hold>: I<boolean>
1035		1047
1036	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1048	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1037	will not immediately destroy its window when the program executed within	1049	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	1050	it exits. Instead, it will wait till it is being killed or closed by the
1039	user.	1051	user.
1040		1052
		1053	=item B<chdir>: I<path>
		1054
		1055	Sets the working directory for the shell (or the command specified via
		1056	B<-e>). The I<path> must be an absolute path and it must exist for
		1057	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1058	directory will be used; option B<-cd>.
		1059
1041	=item B<keysym.>I<sym>: I<string>	1060	=item B<keysym.>I<sym>: I<action>
1042		1061
1043	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1062	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1044	intervening resource name B<keysym.> cannot be omitted.	1063	resource name B<keysym.> cannot be omitted.
1045		1064
1046	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1065	Using this resource, you can map key combinations such as
1047	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1066	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>,	1067	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>,	1068	terminal scroll up or down the way you want it, or any other thing an
1050	B<2>, B<3>, B<4>, B<5>.	1069	extension might provide.
		1070
		1071	The key combination that triggers the action, I<sym>, has the following format:
		1072
		1073	(modifiers-)key
		1074
		1075	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1076	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1077	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1078	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1051		1079
1052	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1080	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	1081	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	1082	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1055	current application keymap mode state.	1083	current application keymap mode state.
1056		1084
1057	The spellings of I<key> can be obtained by using B<xev>(1) command or	1085	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	1086	match if I<at least> the specified identifiers are being set, and no other
		1087	key mappings with those and more bits are being defined. That means that
		1088	defining a mapping for C<a> will automatically provide definitions for
		1089	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1090	themselves. See the C<builtin:> action, below, for a way to work around
		1091	this when this is a problem.
		1092
		1093	The spelling of I<key> depends on your implementation of X. An easy way to
		1094	find a key name is to use the B<xev>(1) command. You can find a list by
		1095	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	1096	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	1097	value (B<0x0000 - 0xFFFF>).
1061	performed in an exact manner; however, the closest match is assured.
1062		1098
1063	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1099	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,	1100	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1065	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1101	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		1102
1070	Please note that you need to double the C<\> in resource files, as	1103	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	1104	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	1105	interpreted as a literal string to pass to the tty (as if it was
1073	processing).	1106	prefixed with C<string:>).
1074		1107
1075	You can define a range of keysyms in one shot by providing a I<string>	1108	The following action prefixes are known - extensions can provide
1076	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1109	additional prefixes:
1077	should be a character not used by the strings.
1078		1110
1079	Its usage can be demonstrated by an example:	1111	=over 4
1080		1112
1081	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1113	=item string:STRING
1082		1114
1083	The above line is equivalent to the following three lines:	1115	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1116	then the remaining C<STRING> will be passed to the program running in the
		1117	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1118	string C<echo rm -rf /> followed by a newline:
1084		1119
1085	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1120	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1086	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1087	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1088		1121
		1122	This could in theory be used to completely redefine your keymap.
		1123
		1124	=item command:STRING
		1125
1089	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1126	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	1127	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1128	the opposite of C<string:> - instead of sending it to the program running
		1129	in the terminal, it will be treated as if it were program output). This is
		1130	most useful to feed command sequences into @@RXVT_NAME@@.
		1131
1091	example the following means "change the current locale to C<zh_CN.GBK>	1132	For example the following means "change the current locale to C<zh_CN.GBK>
1092	when Control-Meta-c is being pressed":	1133	when Control-Meta-c is being pressed":
1093		1134
1094	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1135	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1095		1136
1096	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1137	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)	1138	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1098	manpage. For example, the F<selection> extension (activated via	1139	font-switching at runtime:
1099	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1100		1140
1101	URxvt.keysym.M-C-c: perl:selection:rot13	1141	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1142	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1102		1143
1103	Due the the large number of modifier combinations, a defined key mapping	1144	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	1145	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		1146
1110	Unfortunately, this will override built-in key mappings. For example	1147	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1148	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1149
		1150	=item builtin:
		1151
		1152	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1153	key binding existed for the key combination. The obvious use is to undo
		1154	the effect of existing bindings. The not so obvious use is to reinstate
		1155	bindings when another binding overrides too many modifiers.
		1156
1111	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1157	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	1158	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1113	user-defined keymap using the C<builtin:> replacement:	1159	"holes" into the user-defined keymap using the C<builtin:> replacement:
1114		1160
1115	URxvt.keysym.Insert: <my insert key sequence>	1161	URxvt.keysym.Insert: <my insert key sequence>
1116	URxvt.keysym.S-Insert: builtin:	1162	URxvt.keysym.S-Insert: builtin:
1117		1163
1118	The first line defines a mapping for C<Insert> and I<any> combination	1164	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	1165	of modifiers. The second line re-establishes the default mapping for
1120	C<Shift-Insert>.	1166	C<Shift-Insert>.
1121		1167
1122	The following example will map Control-Meta-1 and Control-Meta-2 to	1168	=item builtin-string:
1123	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1124	font-switching at runtime:
1125		1169
1126	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1170	This action is mainly useful to restore string mappings for keys that
1127	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1171	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1172	difficult to explain - basically, this action will send the string to the
		1173	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1174	action for it.
1128		1175
1129	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1176	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1130	info):	1177	selection when you press C<Shift-Insert>. With the following bindings, it
		1178	would instead emit the (undocumented, but what applications running in the
		1179	terminal might expect) sequence C<ESC [ 2 $> instead:
1131		1180
1132	URxvt.keysym.M-C-3: command:\033[8;25;80t	1181	URxvt.keysym.S-Insert: builtin-string:
1133	URxvt.keysym.M-C-4: command:\033[8;48;110t	1182	URxvt.keysym.C-S-Insert: builtin:
		1183
		1184	The first line disables the paste functionality for that key
		1185	combination, and the second reinstates the default behaviour for
		1186	C<Control-Shift-Insert>, which would otherwise be overridden.
		1187
		1188	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1189	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1190	this:
		1191
		1192	URxvt.keysym.C-M-c: builtin-string:
		1193	URxvt.keysym.C-M-v: builtin-string:
		1194
		1195	=item EXTENSION:STRING
		1196
		1197	An action of this form invokes the action B<STRING>, if any, provided
		1198	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1199	be loaded automatically if necessary.
		1200
		1201	Not all extensions define actions, but popular extensions that do
		1202	include the I<selection> and I<matcher> extensions (documented in their
		1203	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1204	respectively).
		1205
		1206	From the silly examples department, this will rot13-"encrypt"
		1207	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1208	keyboards:
		1209
		1210	URxvt.keysym.M-C-c: selection:rot13
		1211
		1212	=item perl:STRING DEPRECATED
		1213
		1214	This is a deprecated way of invoking commands provided by perl
		1215	extensions. It is still supported, but should not be used anymore.
		1216
		1217	=back
1134		1218
1135	=item B<perl-ext-common>: I<string>	1219	=item B<perl-ext-common>: I<string>
1136		1220
1137	=item B<perl-ext>: I<string>	1221	=item B<perl-ext>: I<string>
1138		1222
…		…
1140	use in this terminal instance; option B<-pe>.	1224	use in this terminal instance; option B<-pe>.
1141		1225
1142	Extension names can be prefixed with a C<-> sign to prohibit using	1226	Extension names can be prefixed with a C<-> sign to prohibit using
1143	them. This can be useful to selectively disable some extensions loaded	1227	them. This can be useful to selectively disable some extensions loaded
1144	by default, or specified via the C<perl-ext-common> resource. For	1228	by default, or specified via the C<perl-ext-common> resource. For
1145	example, C<default,-selection> will use all the default extension except	1229	example, C<default,-selection> will use all the default extensions except
1146	C<selection>.	1230	C<selection>.
1147		1231
1148	Extension names can also be followed by an argument in angle brackets	1232	The default set includes the C<selection>, C<option-popup>,
1149	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1233	C<selection-popup> and C<readline> extensions, any extensions that
1150	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1234	define keybindings via C<BINDING> meta comments, and extensions which
1151	multiple times with different arguments will pass multiple arguments to	1235	are mentioned in B<keysym> resources.
1152	the extension.	1236
		1237	Any extension such that a corresponding resource is given on the
		1238	command line is automatically appended to B<perl-ext>.
1153		1239
1154	Each extension is looked up in the library directories, loaded if	1240	Each extension is looked up in the library directories, loaded if
1155	necessary, and bound to the current terminal instance.	1241	necessary, and bound to the current terminal instance. When the library
		1242	search path contains multiple extension files of the same name, then the
		1243	first one found will be used.
1156		1244
1157	If both of these resources are the empty string, then the perl	1245	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	1246	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	1247	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.	1248	all instances, while B<perl-ext> is used for specific instances.
1161		1249
1162	=item B<perl-eval>: I<string>	1250	=item B<perl-eval>: I<string>
1163		1251
1164	Perl code to be evaluated when all extensions have been registered. See	1252	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	1253	the @@RXVT_NAME@@perl(3) manpage.
1166	will be ignored when running setuid/setgid.
1167		1254
1168	=item B<perl-lib>: I<path>	1255	=item B<perl-lib>: I<path>
1169		1256
1170	Colon-separated list of additional directories that hold extension	1257	Colon-separated list of additional directories that hold extension
1171	scripts. When looking for extensions specified by the C<perl> resource,	1258	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1172	@@RXVT_NAME@@ will first look in these directories and then in	1259	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	1260	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1174	will be ignored when running setuid/setgid.
1175		1261
1176	See the @@RXVT_NAME@@perl(3) manpage.	1262	See the @@RXVT_NAME@@perl(3) manpage.
1177		1263
1178	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1264	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1179		1265
…		…
1183	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1269	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1184		1270
1185	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1271	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1186	for details.	1272	for details.
1187		1273
1188	=item B<searchable-scrollback:> I<keysym>	1274	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1189		1275
1190	Sets the hotkey that starts the incremental scrollback buffer search	1276	This resource is deprecated and will be removed. Use a B<keysym> resource
1191	(default: C<M-s>).	1277	instead, e.g.:
1192		1278
		1279	URxvt.keysym.M-s: searchable-scrollback:start
		1280
1193	=item B<urlLauncher>: I<string>	1281	=item B<url-launcher>: I<string>
1194		1282
1195	Specifies the program to be started with a URL argument. Used by the	1283	Specifies the program to be started with a URL argument. Used by the
1196	C<selection-popup> and C<matcher> perl extensions.	1284	C<selection-popup> and C<matcher> perl extensions.
1197		1285
1198	=item B<transient-for>: I<windowid>	1286	=item B<transient-for>: I<windowid>
…		…
1202	=item B<override-redirect>: I<boolean>	1290	=item B<override-redirect>: I<boolean>
1203		1291
1204	Compile I<frills>: Sets override-redirect for the terminal window, making	1292	Compile I<frills>: Sets override-redirect for the terminal window, making
1205	it almost invisible to window managers; option B<-override-redirect>.	1293	it almost invisible to window managers; option B<-override-redirect>.
1206		1294
		1295	=item B<iso14755:> I<boolean>
		1296
		1297	Turn on/off ISO 14755 (default enabled).
		1298
1207	=item B<iso14755_52:> I<boolean>	1299	=item B<iso14755_52:> I<boolean>
1208		1300
1209	Turn on/off ISO 14755 5.2 mode (default enabled).	1301	Turn on/off ISO 14755 5.2 mode (default enabled).
		1302
		1303	=back
		1304
		1305	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1306
		1307	=over 4
		1308
		1309	=item B<-pixmap> I<file[;oplist]>
		1310
		1311	=item B<backgroundPixmap:> I<file[;oplist]>
		1312
		1313	Compile I<pixbuf>: Use the specified image file as the window's
		1314	background and also optionally specify a colon separated list of
		1315	operations to modify it. Note that you may need to quote the C<;>
		1316	character when using the command line option, as C<;> is usually a
		1317	metacharacter in shells. Supported operations are:
		1318
		1319	=over 4
		1320
		1321	=item B<WxH+X+Y>
		1322
		1323	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1324	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1325	scale of 0 disables scaling.
		1326
		1327	=item B<op=tile>
		1328
		1329	enables tiling
		1330
		1331	=item B<op=keep-aspect>
		1332
		1333	maintain the image aspect ratio when scaling
		1334
		1335	=item B<op=root-align>
		1336
		1337	use the position of the terminal window relative to the root window as
		1338	the image offset, simulating a root window background
		1339
		1340	=back
		1341
		1342	The default scale and position setting is C<100x100+50+50>.
		1343	Alternatively, a predefined set of templates can be used to achieve
		1344	the most common setups:
		1345
		1346	=over 4
		1347
		1348	=item B<style=tiled>
		1349
		1350	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1351
		1352	=item B<style=aspect-stretched>
		1353
		1354	the image is scaled to fill the whole window maintaining the aspect
		1355	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1356
		1357	=item B<style=stretched>
		1358
		1359	the image is scaled to fill the whole window. Equivalent to 100x100
		1360
		1361	=item B<style=centered>
		1362
		1363	the image is centered with no scaling. Equivalent to 0x0+50+50
		1364
		1365	=item B<style=root-tiled>
		1366
		1367	the image is tiled with no scaling and using 'root' positioning.
		1368	Equivalent to 0x0:op=tile:op=root-align
		1369
		1370	=back
		1371
		1372	If multiple templates are specified the last one wins. Note that a
		1373	template overrides all the scale, position and operations settings.
		1374
		1375	If used in conjunction with pseudo-transparency, the specified pixmap
		1376	will be blended over the transparent background using alpha-blending.
		1377
		1378	=item B<-tr>\|B<+tr>
		1379
		1380	=item B<transparent:> I<boolean>
		1381
		1382	Turn on/off pseudo-transparency by using the root pixmap as background.
		1383
		1384	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1385	will be removed in future versions.
		1386
		1387	=item B<-tint> I<colour>
		1388
		1389	=item B<tintColor:> I<colour>
		1390
		1391	Tint the transparent background with the given colour. Note that a
		1392	black tint yields a completely black image while a white tint yields
		1393	the image unchanged.
		1394
		1395	=item B<-sh> I<number>
		1396
		1397	=item B<shading:> I<number>
		1398
		1399	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1400	A value of 100 means no shading.
		1401
		1402	=item B<-blr> I<HxV>
		1403
		1404	=item B<blurRadius:> I<HxV>
		1405
		1406	Apply gaussian blur with the specified radius to the transparent
		1407	background. If a single number is specified, the vertical and
		1408	horizontal radii are considered to be the same. Setting one of the
		1409	radii to 1 and the other to a large number creates interesting effects
		1410	on some backgrounds. The maximum radius value is 128. An horizontal or
		1411	vertical radius of 0 disables blurring.
		1412
		1413	=item B<path:> I<path>
		1414
		1415	Specify the colon-delimited search path for finding background image files.
1210		1416
1211	=back	1417	=back
1212		1418
1213	=head1 THE SCROLLBAR	1419	=head1 THE SCROLLBAR
1214		1420
…		…
1263	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1469	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1264		1470
1265	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1471	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1266	inserted too.	1472	inserted too.
1267		1473
		1474	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1475	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1476	binding causes the value of the internal selection to be copied to the
		1477	CLIPBOARD selection, while the second binding causes the value of the
		1478	CLIPBOARD selection to be inserted.
		1479
1268	=back	1480	=back
1269		1481
1270	=head1 CHANGING FONTS	1482	=head1 CHANGING FONTS
1271		1483
1272	Changing fonts (or font sizes, respectively) via the keypad is not yet	1484	Changing fonts (or font sizes, respectively) via the keypad is not yet
…		…
1285		1497
1286	=head1 ISO 14755 SUPPORT	1498	=head1 ISO 14755 SUPPORT
1287		1499
1288	ISO 14755 is a standard for entering and viewing unicode characters	1500	ISO 14755 is a standard for entering and viewing unicode characters
1289	and character codes using the keyboard. It consists of 4 parts. The	1501	and character codes using the keyboard. It consists of 4 parts. The
1290	first part is available rxvt-unicode has been compiled with	1502	first part is available if rxvt-unicode has been compiled with
1291	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1503	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1292	with C<--enable-iso14755>.	1504	with C<--enable-iso14755>.
1293		1505
1294	=over 4	1506	=over 4
1295		1507
…		…
1353	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1565	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	1566	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	1567	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.	1568	on some systems or setgid to root or to some other group on others.
1357		1569
1358	=head1 COLORS AND GRAPHICS	1570	=head1 COLOURS AND GRAPHICS
1359		1571
1360	In addition to the default foreground and background colours,	1572	In addition to the default foreground and background colours,
1361	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1573	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	1574	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1363	colours with their names.	1575	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1576	cube plus a 8 (24) colour greyscale ramp.
		1577
		1578	Here is a list of the ANSI colours with their names.
1364		1579
1365	=begin table	1580	=begin table
1366		1581
1367	B<color0> (black) = Black	1582	B<color0> (black) = Black
1368	B<color1> (red) = Red3	1583	B<color1> (red) = Red3
…		…
1388	It is also possible to specify the colour values of B<foreground>,	1603	It is also possible to specify the colour values of B<foreground>,
1389	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1604	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	1605	a number 0-15, as a convenient shorthand to reference the colour name of
1391	color0-color15.	1606	color0-color15.
1392		1607
1393	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1608	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)	1609	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		1610
		1611	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1612
		1613	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1614	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1615
		1616	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1617	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1618	the RGB cube.
		1619
1398	Together, all those colours implement the 88 colour xterm colours. Only	1620	Together, all those colours implement the 88 (256) colour xterm
1399	the first 16 can be changed using resources currently, the rest can only	1621	colours. Only the first 16 can be changed using resources currently, the
1400	be changed via command sequences ("escape codes").	1622	rest can only be changed via command sequences ("escape codes").
		1623
		1624	Applications are advised to use terminfo or command sequences to discover
		1625	number and RGB values of all colours (yes, you can query this...).
1401		1626
1402	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1627	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1403	always swapping the foreground/background colours. This is in contrast to	1628	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	1629	I<xterm>(1) where the colours are only swapped if they have not otherwise
1405	been specified. For example,	1630	been specified. For example,
1406		1631
1407	=over 4
1408
1409	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1632	@@RXVT_NAME@@ -fg Black -bg White -rv
1410		1633
1411	would yield White on Black, while on I<xterm>(1) it would yield Black	1634	would yield White on Black, while on I<xterm>(1) it would yield Black on
1412	on White.	1635	White.
1413
1414	=back
1415		1636
1416	=head2 ALPHA CHANNEL SUPPORT	1637	=head2 ALPHA CHANNEL SUPPORT
1417		1638
1418	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1639	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>	1640	their act together, rxvt-unicode will do its own alpha channel management:
1420	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1641
1421	in addition to the ones provided by X, where the additional A component	1642	You can prefix any colour with an opaqueness percentage enclosed in
		1643	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1644	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1645	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1646	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1647	is the recommended format to specify transparency values, and works with
		1648	all ways to specify a colour.
		1649
		1650	For complete control, rxvt-unicode also supports
		1651	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1652	specifications, where the additional C<aaaa> component specifies opacity
1422	specifies opacity (alpha) values. The minimum value of C<0> is completely	1653	(alpha) values. The minimum value of C<0000> is completely transparent,
1423	transparent). You can also prefix any color with C<[percent]>, where	1654	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	1655	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	1656	C<rgba:0000/ff00/0000/f332>.
1426	opaque.
1427		1657
1428	You probably need to specify B<"-depth 32">, too, and have the luck that	1658	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	1659	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.	1660	layout, as X is far from just supporting ARGB visuals out of the box, and
		1661	rxvt-unicode just fudges around.
1431		1662
1432	For example, the following selects an almost completely transparent red	1663	For example, the following selects an almost completely transparent black
1433	background, and an almost opaque pink foreground:	1664	background, and an almost opaque pink foreground:
1434		1665
1435	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1666	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1436		1667
1437	I<Please note that transparency of any kind if completely unsupported by	1668	When not using a background image, then the interpretation of the
1438	the author. Don't bug him with installation questions!>	1669	alpha channel is up to your compositing manager (most interpret it as
		1670	transparency of course).
		1671
		1672	When using a background pixmap or pseudo-transparency, then the background
		1673	colour will always behave as if it were completely transparent (so the
		1674	background image shows instead), regardless of how it was specified, while
		1675	other colours will either be transparent as specified (the background
		1676	image will show through) on servers supporting the RENDER extension, or
		1677	fully opaque on servers not supporting the RENDER EXTENSION.
		1678
		1679	Please note that due to bugs in Xft, specifying alpha values might result
		1680	in garbage being displayed when the X-server does not support the RENDER
		1681	extension.
1439		1682
1440	=head1 ENVIRONMENT	1683	=head1 ENVIRONMENT
1441		1684
1442	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1685	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1443		1686
…		…
1449	resources or on the command line.	1692	resources or on the command line.
1450		1693
1451	=item B<COLORTERM>	1694	=item B<COLORTERM>
1452		1695
1453	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1696	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1454	compiled with XPM support, and optionally with the added extension	1697	compiled with background image support, and optionally with the added
1455	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1698	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1699	screen.
1456		1700
1457	=item B<COLORFGBG>	1701	=item B<COLORFGBG>
1458		1702
1459	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1703	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	1704	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	1705	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	1706	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@@	1707	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	1708	was compiled with background image support. Libraries like C<ncurses>
1465	(and do) use this information to optimize screen output.	1709	and C<slang> can (and do) use this information to optimize screen output.
1466		1710
1467	=item B<WINDOWID>	1711	=item B<WINDOWID>
1468		1712
1469	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1713	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	1714	window, which usually has subwindows for the scrollbar, the terminal
…		…
1476	C<--with-terminfo=PATH>.	1720	C<--with-terminfo=PATH>.
1477		1721
1478	=item B<DISPLAY>	1722	=item B<DISPLAY>
1479		1723
1480	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1724	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1481	display in its child processes.	1725	display in its child processes if C<-display> isn't used to override. It
		1726	defaults to C<:0> if it doesn't exist.
1482		1727
1483	=item B<SHELL>	1728	=item B<SHELL>
1484		1729
1485	The shell to be used for command execution, defaults to C</bin/sh>.	1730	The shell to be used for command execution, defaults to C</bin/sh>.
1486		1731
1487	=item B<RXVT_SOCKET>	1732	=item B<RXVT_SOCKET> [I<sic>]
1488		1733
1489	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1734	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1490	@@RXVT_NAME@@d(1).	1735	@@RXVT_NAME@@d(1).
1491		1736
1492	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1737	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1738
		1739	=item B<URXVT_PERL_LIB>
		1740
		1741	Additional F<:>-separated library search path for perl extensions. Will be
		1742	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1743	directory.
		1744
		1745	=item B<URXVT_PERL_VERBOSITY>
		1746
		1747	See L<@@RXVT_NAME@@perl>(3).
1493		1748
1494	=item B<HOME>	1749	=item B<HOME>
1495		1750
1496	Used to locate the default directory for the unix domain socket for	1751	Used to locate the default directory for the unix domain socket for
1497	daemon communications and to locate various resource files (such as	1752	daemon communications and to locate various resource files (such as
1498	C<.Xdefaults>)	1753	C<.Xdefaults>)
1499		1754
1500	=item B<XAPPLRESDIR>	1755	=item B<XAPPLRESDIR>
1501		1756
1502	Directory where various X resource files are being located.	1757	Directory where application-specific X resource files are located.
1503		1758
1504	=item B<XENVIRONMENT>	1759	=item B<XENVIRONMENT>
1505		1760
1506	If set and accessible, gives the name of a X resource file to be loaded by	1761	If set and accessible, gives the name of a X resource file to be loaded by
1507	@@RXVT_NAME@@.	1762	@@RXVT_NAME@@.
…		…
1512		1767
1513	=over 4	1768	=over 4
1514		1769
1515	=item B</usr/lib/X11/rgb.txt>	1770	=item B</usr/lib/X11/rgb.txt>
1516		1771
1517	Color names.	1772	Colour names.
1518		1773
1519	=back	1774	=back
1520		1775
1521	=head1 SEE ALSO	1776	=head1 SEE ALSO
1522		1777
		1778	@@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)	1779	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1524		1780
1525	=head1 CURRENT PROJECT COORDINATOR	1781	=head1 CURRENT PROJECT COORDINATOR
1526		1782
1527	=over 4	1783	=over 4
1528		1784
1529	=item Project Coordinator	1785	=item Project Coordinator
1530		1786
1531	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1787	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1532		1788
1533	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1789	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1534		1790
1535	=back	1791	=back
1536		1792
…		…
1540		1796
1541	=item John Bovey	1797	=item John Bovey
1542		1798
1543	University of Kent, 1992, wrote the original Xvt.	1799	University of Kent, 1992, wrote the original Xvt.
1544		1800
1545	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1801	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1546		1802
1547	very heavily modified Xvt and came up with Rxvt	1803	very heavily modified Xvt and came up with Rxvt
1548		1804
1549	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1805	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1550		1806
1551	wrote the Greek Keyboard Input (no longer in code)	1807	wrote the Greek Keyboard Input (no longer in code)
1552		1808
1553	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1809	=item mj olesen <olesen@me.QueensU.CA>
1554		1810
1555	Wrote the menu system.	1811	Wrote the menu system.
1556		1812
1557	Project Coordinator (changes.txt 2.11 to 2.21)	1813	Project Coordinator (changes.txt 2.11 to 2.21)
1558		1814
1559	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1815	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1560		1816
1561	Project Coordinator (changes.txt 2.21a to 2.4.5)	1817	Project Coordinator (changes.txt 2.21a to 2.4.5)
1562		1818
1563	=item Geoff Wing L<< <gcw@pobox.com> >>	1819	=item Geoff Wing <gcw@pobox.com>
1564		1820
1565	Rewrote screen display and text selection routines.	1821	Rewrote screen display and text selection routines.
1566		1822
1567	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1823	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1568		1824
1569	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1825	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1570		1826
1571	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1827	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1572	extension, random hacks, numerous bugfixes and extensions.	1828	extension, random hacks, numerous bugfixes and extensions.
1573		1829
1574	Project Coordinator (Changes 1.0 -)	1830	Project Coordinator (Changes 1.0 -)
1575		1831
1576	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1832	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1577		1833
1578	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1834	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1579		1835
1580	=back	1836	=back
1581		1837

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.239 by sf-exg, Sun Oct 12 20:51:51 2014 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.239 by sf-exg, Sun Oct 12 20:51:51 2014 UTC