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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.122 by root, Sat Nov 25 14:50:16 2006 UTC vs. Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.122 by root, Sat Nov 25 14:50:16 2006 UTC vs.
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC