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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.116 by root, Mon Jul 10 04:03:09 2006 UTC vs.
Revision 1.196 by root, Fri May 6 10:18:00 2011 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very userfriendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
41	terminal emulator. In fact, the reason rxvt-unicode was born was solely	44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
42	because the author couldn't get C<mlterm> to use one font for latin1 and	45	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
…		…
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<xft>: 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
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
107	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
108		116
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		118
111	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
112		120
113	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		122
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		126
120	I<Please note that transparency of any kind if completely unsupported by	127	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions!>	128
		129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
122		133
123	=item B<-fade> I<number>	134	=item B<-fade> I<number>
124		135
125	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
126	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
…		…
131	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
132	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
133		144
134	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
135		146
136	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
137	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	resource I<tintColor>.
138	non-tiled backgrounds, currently. See also the B<-sh> option that can be
139	used to brighten or darken the image in addition to tinting it; resource
140	I<tintColor>. Example:
141		149
142	@@RXVT_NAME@@ -tr -tint blue -sh 40	150	=item B<-sh> I<number>
143		151
144	=item B<-sh>
145
146	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
147	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
148	specified, too, e.g. C<-tint white>).	154
		155	=item B<-blt> I<string>
		156
		157	Specify background blending type. If background pixmap is specified
		158	at the same time as transparency - such pixmap will be blended over
		159	the transparent background, using the method specified. Supported values are:
		160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
		161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		164
		165	=item B<-blr> I<HxV>
		166
		167	Apply Gaussian Blur with the specified radii to the transparent
		168	background. If a single number is specified - both vertical and
		169	horizontal radii are considered to be the same. Setting one of the
		170	radii to 1 and another to a large number creates interesting effects
		171	on some backgrounds. Maximum radius value is 128;
		172	resource I<blurRadius>.
		173
		174	=item B<-icon> I<file>
		175
		176	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		177	is used by many window managers, taskbars and pagers to represent the
		178	application window; resource I<iconFile>.
149		179
150	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
151		181
152	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
153		183
154	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
155		185
156	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
157		187
158	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
159		189
160	Compile I<XPM>: Specify XPM file for the background and also optionally	190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
161	specify its scaling with a geometry string. Note you may need to	191	optionally specify its scaling with a geometry string. Note you may need to
162	add quotes to avoid special shell interpretation of the C<;> in the	192	add quotes to avoid special shell interpretation of the C<;> in the
163	command-line; resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
164		194
165	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
166		196
167	The cursor colour; resource B<cursorColor>.	197	The cursor colour; resource B<cursorColor>.
168		198
…		…
213	italic> >> characters are to be printed. See resource B<boldItalicFont>	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
214	for details.	244	for details.
215		245
216	=item B<-is>\|B<+is>	246	=item B<-is>\|B<+is>
217		247
218	Compile I<font-styles>: Bold/Italic font styles imply high intensity	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
219	foreground/background (default). See resource B<intensityStyles> for	249	foreground/background (default). See resource B<intensityStyles> for
220	details.	250	details.
221		251
222	=item B<-name> I<name>	252	=item B<-name> I<name>
223		253
…		…
241		271
242	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
243		273
244	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
245		275
		276	=item B<-sr>\|B<+sr>
		277
		278	Put scrollbar on right/left; resource B<scrollBar_right>.
		279
		280	=item B<-st>\|B<+st>
		281
		282	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		283	resource B<scrollBar_floating>.
		284
246	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
247		286
248	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
249	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
250		289
…		…
256	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
257		296
258	Turn on/off scrolling with the scrollback buffer as new lines appear.	297	Turn on/off scrolling with the scrollback buffer as new lines appear.
259	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
260	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
261
262	=item B<-sr>\|B<+sr>
263
264	Put scrollbar on right/left; resource B<scrollBar_right>.
265
266	=item B<-st>\|B<+st>
267
268	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
269	resource B<scrollBar_floating>.
270		300
271	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
272		302
273	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
274	actual wide characters in the screen buffer, which makes it possible to	304	actual wide characters in the screen buffer, which makes it possible to
…		…
278		308
279	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
280		310
281	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
282		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
283	=item B<-iconic>	317	=item B<-iconic>
284		318
285	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
286	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
287		321
…		…
303		337
304	=item B<-bl>	338	=item B<-bl>
305		339
306	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	340	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
307	if honoured by the WM, the rxvt-unicode window will not have window	341	if honoured by the WM, the rxvt-unicode window will not have window
308	decorations; resource B<borderLess>.	342	decorations; resource B<borderLess>. If the window manager does not
		343	support MWM hints (e.g. kwin), enables override-redirect mode.
309		344
310	=item B<-override-redirect>	345	=item B<-override-redirect>
311		346
312	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
313	B<override-redirect>.	348	B<override-redirect>.
…		…
321		356
322	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
323		358
324	Compile I<frills>: Lines (pixel height) to insert between each row of	359	Compile I<frills>: Lines (pixel height) to insert between each row of
325	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
326	B<linespace>.	361	B<lineSpace>.
		362
		363	=item B<-letsp> I<number>
		364
		365	Compile I<frills>: Amount to adjust the computed character width by
		366	to control overall letter spacing. Negative values will tighten up the
		367	letter spacing, positive values will space letters out more. Useful to
		368	work around odd font metrics; resource B<letterSpace>.
327		369
328	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
329		371
330	This option specifies the name of the terminal type to be set in the	372	This option specifies the name of the terminal type to be set in the
331	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
385	for more info.	427	for more info.
386		428
387	=item B<-tcw>	429	=item B<-tcw>
388		430
389	Change the meaning of triple-click selection with the left mouse	431	Change the meaning of triple-click selection with the left mouse
		432	button. Only effective when the original (non-perl) selection code is
390	button. Instead of selecting a full line it will extend the selection the	433	in-use. Instead of selecting a full line it will extend the selection to
391	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
392		435
393	=item B<-insecure>	436	=item B<-insecure>
394		437
395	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
396	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
417	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	460	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
418	will not immediately destroy its window when the program executed within	461	will not immediately destroy its window when the program executed within
419	it exits. Instead, it will wait till it is being killed or closed by the	462	it exits. Instead, it will wait till it is being killed or closed by the
420	user; resource B<hold>.	463	user; resource B<hold>.
421		464
		465	=item B<-cd> I<path>
		466
		467	Sets the working directory for the shell (or the command specified via
		468	B<-e>). The I<path> must be an absolute path and it must exist for
		469	@@RXVT_NAME@@ to start; resource B<chdir>.
		470
		471	=item B<-xrm> I<string>
		472
		473	Works like the X Toolkit option of the same name, by adding the I<string>
		474	as if it were specified in a resource file. Resource values specified this
		475	way take precedence over all other resource specifications.
		476
		477	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		478	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		479	options can be specified as long-options on the commandline, so use
		480	of B<-xrm> is mostly limited to cases where you want to specify other
		481	resources (e.g. for input methods) or for compatibility with other
		482	programs.
		483
422	=item B<-keysym.>I<sym> I<string>	484	=item B<-keysym.>I<sym> I<string>
423		485
424	Remap a key symbol. See resource B<keysym>.	486	Remap a key symbol. See resource B<keysym>.
425		487
426	=item B<-embed> I<windowid>	488	=item B<-embed> I<windowid>
…		…
436	The window will not be destroyed when @@RXVT_NAME@@ exits.	498	The window will not be destroyed when @@RXVT_NAME@@ exits.
437		499
438	It might be useful to know that @@RXVT_NAME@@ will not close file	500	It might be useful to know that @@RXVT_NAME@@ will not close file
439	descriptors passed to it (except for stdin/out/err, of course), so you	501	descriptors passed to it (except for stdin/out/err, of course), so you
440	can use file descriptors to communicate with the programs within the	502	can use file descriptors to communicate with the programs within the
441	terminal. This works regardless of wether the C<-embed> option was used or	503	terminal. This works regardless of whether the C<-embed> option was used or
442	not.	504	not.
443		505
444	Here is a short Gtk2-perl snippet that illustrates how this option can be	506	Here is a short Gtk2-perl snippet that illustrates how this option can be
445	used (a longer example is in F<doc/embed>):	507	used (a longer example is in F<doc/embed>):
446		508
…		…
451	});	513	});
452		514
453	=item B<-pty-fd> I<file descriptor>	515	=item B<-pty-fd> I<file descriptor>
454		516
455	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	517	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
456	pair but instead use the given filehandle as the tty master. This is	518	pair but instead use the given file descriptor as the tty master. This is
457	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	519	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458	without having to run a program within it.	520	without having to run a program within it.
459		521
460	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	522	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
461	entries and will not tinker with pty/tty permissions - you have to do that	523	entries and will not tinker with pty/tty permissions - you have to do that
462	yourself if you want that.	524	yourself if you want that.
463		525
464	As an extremely special case, specifying C<-1> will completely suppress	526	As an extremely special case, specifying C<-1> will completely suppress
465	pty/tty operations.	527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
466		529
467	Here is a example in perl that illustrates how this option can be used (a	530	Here is a example in perl that illustrates how this option can be used (a
468	longer example is in F<doc/pty-fd>):	531	longer example is in F<doc/pty-fd>):
469		532
470	use IO::Pty;	533	use IO::Pty;
…		…
484	Comma-separated list of perl extension scripts to use (or not to use) in	547	Comma-separated list of perl extension scripts to use (or not to use) in
485	this terminal instance. See resource B<perl-ext> for details.	548	this terminal instance. See resource B<perl-ext> for details.
486		549
487	=back	550	=back
488		551
489	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
490		553
491	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
492	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
493		557
494	You can set and change the resources using X11 tools like B<xrdb>. Many	558	You can set and change the resources using X11 tools like B<xrdb>. Many
495	distribution do also load settings from the B<~/.Xresources> file when X	559	distribution do also load settings from the B<~/.Xresources> file when X
496	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
497	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
498		562
499	1. system-wide app-defaults file, either locale-dependent OR global
500	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
501	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
502	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
503	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
504		569
505	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
506	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	571	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
507	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	572	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
508	configured, while the class name B<URxvt> allows resources unique to	573	configured, while the class name B<URxvt> allows resources unique to
…		…
518	=item B<depth:> I<bitdepth>	583	=item B<depth:> I<bitdepth>
519		584
520	Compile I<xft>: Attempt to find a visual with the given bit depth;	585	Compile I<xft>: Attempt to find a visual with the given bit depth;
521	option B<-depth>.	586	option B<-depth>.
522		587
		588	=item B<buffered:> I<boolean>
		589
		590	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		591	On some card/driver combination enabling it slightly decreases
		592	performance, on most it greatly helps it. The slowdown is small, so it
		593	should normally be enabled.
		594
523	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
524		596
525	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
526	option B<-geometry>.	598	option B<-geometry>.
527		599
…		…
540	Use the specified colour for the colour value I<n>, where 0-7	612	Use the specified colour for the colour value I<n>, where 0-7
541	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
542	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
543	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	615	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
544	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	616	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
545	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
546		618
547	Colours higher than 15 cannot be set using resources (yet), but can be	619	Colours higher than 15 cannot be set using resources (yet), but can be
548	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
549		621
550	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	622	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
561	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
562		634
563	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
564	foreground colour is the default.	636	foreground colour is the default.
565		637
566	=item B<colorRV:> I<colour>
567
568	Use the specified colour as the background for reverse video
569	characters.
570
571	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
572		639
573	If set, use the specified colour as the colour for the underline	640	If set, use the specified colour as the colour for the underline
574	itself. If unset, use the foreground colour.	641	itself. If unset, use the foreground colour.
		642
		643	=item B<highlightColor:> I<colour>
		644
		645	If set, use the specified colour as the background for highlighted
		646	characters. If unset, use reverse video.
		647
		648	=item B<highlightTextColor:> I<colour>
		649
		650	If set and highlightColor is set, use the specified colour as the
		651	foreground for highlighted characters.
575		652
576	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
577		654
578	Use the specified colour for the cursor. The default is to use the	655	Use the specified colour for the cursor. The default is to use the
579	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
586		663
587	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
588		665
589	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
590	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
591	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
592		669
593	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
594		671
595	B<True>: specify that jump scrolling should be used. When scrolling	672	B<True>: specify that jump scrolling should be used. When receiving lots
596	quickly, fewer screen updates are performed [default]; option B<-j>.	673	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		674	has been read, resulting in fewer updates while still displaying every
		675	received line; option B<-j>.
		676
597	B<False>: specify that smooth scrolling should be used; option B<+j>.	677	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		678	force a screen refresh on each new line it received; option B<+j>.
598		679
599	=item B<inheritPixmap:> I<boolean>	680	=item B<skipScroll:> I<boolean>
600		681
601	B<True>: make the background inherit the parent windows' pixmap, giving	682	B<True>: (the default) specify that skip scrolling should be used. When
602	artificial transparency. B<False>: do not inherit the parent windows'	683	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
603	pixmap.	684	(around 60 times per second), resulting in far fewer updates. This can
		685	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		686	option B<-ss>.
604		687
605	I<Please note that transparency of any kind if completely unsupported by	688	B<False>: specify that everything is to be displayed, even
606	the author. Don't bug him with installation questions!>	689	if the refresh is too fast for the human eye to read anything (or the
		690	monitor to display anything); option B<+ss>.
		691
		692	=item B<transparent:> I<boolean>
		693
		694	Turn on/off pseudo-transparency by using the root pixmap as background.
		695
		696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		697	future versions.
607		698
608	=item B<fading:> I<number>	699	=item B<fading:> I<number>
609		700
610	Fade the text by the given percentage when focus is lost; option B<-fade>.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
611		702
…		…
614	Fade to this colour, when fading is used (see B<fading:>). The default	705	Fade to this colour, when fading is used (see B<fading:>). The default
615	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
616		707
617	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
618		709
619	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
620	B<-tint>.	711	extension is not available only black, red, green, yellow, blue,
		712	magenta, cyan and white tints can be performed server-side. Note that
		713	a black tint yields a completely black image while a white tint yields
		714	the image unchanged; option B<-tint>.
621		715
622	=item B<shading:> I<number>	716	=item B<shading:> I<number>
623		717
624	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
625	image in addition to tinting it.	719	A value of 100 means no shading; option B<-sh>.
		720
		721	=item B<blendType:> I<string>
		722
		723	Specify background blending type; option B<-blt>.
		724
		725	=item B<blurRadius:> I<number>
		726
		727	Apply gaussian blur with the specified radius to the transparent
		728	background; option B<-blr>.
		729
		730	=item B<iconFile:> I<file>
		731
		732	Set the application icon pixmap; option B<-icon>.
626		733
627	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
628		735
629	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
630		737
…		…
636	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
637		744
638	The colour of the border around the text area and between the scrollbar	745	The colour of the border around the text area and between the scrollbar
639	and the text.	746	and the text.
640		747
641	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
642		749
643	Use the specified XPM file (note the `.xpm' extension is optional) for	750	Use the specified image file for the background and also
644	the background and also optionally specify its scaling with a geometry	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
645	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	752	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
646	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
647	centre (percent). A scale of 0 displays the image with tiling. A scale	754	centre (percent). A scale of 0 displays the image with tiling.
648	of 1 displays the image without any scaling. A scale of 2 to 9	755	The maximum permitted scale is 1000.
649	specifies an integer number of images in that direction. No image will	756	Additional operations can be specified after colon B<:op1:op2...>.
650	be magnified beyond 10 times its original size. The maximum permitted	757	Supported operations are:
651	scale is 1000. [default 0x0+50+50]	758
		759	tile force background image to be tiled and not scaled. Equivalent to 0x0
		760	propscale will scale image keeping proportions
		761	auto will scale image to match window size. Equivalent to 100x100
		762	hscale will scale image horizontally to the window size
		763	vscale will scale image vertically to the window size
		764	scale will scale image to match window size
		765	root will tile image as if it was a root window background, auto-adjusting
		766	whenever terminal window moves
		767
		768	If used in conjunction with B<-tr> option, the specified pixmap will be
		769	blended over the transparent background using alpha-blending. If I<afterimage>
		770	support has been compiled in it is possible to choose other blending
		771	types with B<-blt "type"> option.
652		772
653	=item B<path:> I<path>	773	=item B<path:> I<path>
654		774
655	Specify the colon-delimited search path for finding XPM files.	775	Specify the colon-delimited search path for finding background image files.
656		776
657	=item B<font:> I<fontlist>	777	=item B<font:> I<fontlist>
658		778
659	Select the fonts to be used. This is a comma separated list of font names	779	Select the fonts to be used. This is a comma separated list of font names
660	that are checked in order when trying to find glyphs for characters. The	780	that are checked in order when trying to find glyphs for characters. The
…		…
683	it is named first) and thus defines the character cell grid to be 9 pixels	803	it is named first) and thus defines the character cell grid to be 9 pixels
684	wide and 15 pixels high.	804	wide and 15 pixels high.
685		805
686	The second font is just used to add additional unicode characters not in	806	The second font is just used to add additional unicode characters not in
687	the base font, likewise the third, which is unfortunately non-bold, but	807	the base font, likewise the third, which is unfortunately non-bold, but
688	the bold version of the font does contain less characters, so this is a	808	the bold version of the font does contain fewer characters, so this is a
689	useful supplement.	809	useful supplement.
690		810
691	The third font is an Xft font with aliasing turned off, and the characters	811	The third font is an Xft font with aliasing turned off, and the characters
692	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	812	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
693	contains other characters, but we are not interested in them.	813	contains other characters, but we are not interested in them.
…		…
717	text font will being used for the given style.	837	text font will being used for the given style.
718		838
719	=item B<intensityStyles:> I<boolean>	839	=item B<intensityStyles:> I<boolean>
720		840
721	When font styles are not enabled, or this option is enabled (B<True>,	841	When font styles are not enabled, or this option is enabled (B<True>,
722	option B<-is>, the default), bold and italic font styles imply high	842	option B<-is>, the default), bold/blink font styles imply high
723	intensity foreground/backround colours. Disabling this option (B<False>,	843	intensity foreground/background colours. Disabling this option (B<False>,
724	option B<+is>) disables this behaviour, the high intensity colours are not	844	option B<+is>) disables this behaviour, the high intensity colours are not
725	reachable.	845	reachable.
726
727	=item B<selectstyle:> I<mode>
728
729	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
730	xterm style with 2.20 old word selection, or anything else which gives
731	xterm style selection.
732
733	=item B<scrollstyle:> I<mode>
734
735	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
736	the author's favourite.
737		846
738	=item B<title:> I<string>	847	=item B<title:> I<string>
739		848
740	Set window title string, the default title is the command-line	849	Set window title string, the default title is the command-line
741	specified after the B<-e> option, if any, otherwise the application	850	specified after the B<-e> option, if any, otherwise the application
…		…
750	=item B<mapAlert:> I<boolean>	859	=item B<mapAlert:> I<boolean>
751		860
752	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	861	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
753	de-iconify (map) on receipt of a bell character [default].	862	de-iconify (map) on receipt of a bell character [default].
754		863
		864	=item B<urgentOnBell:> I<boolean>
		865
		866	B<True>: set the urgency hint for the wm on receipt of a bell character.
		867	B<False>: do not set the urgency hint [default].
		868
		869	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		870
755	=item B<visualBell:> I<boolean>	871	=item B<visualBell:> I<boolean>
756		872
757	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	873	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
758	B<False>: no visual bell [default]; option B<+vb>.	874	B<False>: no visual bell [default]; option B<+vb>.
759		875
…		…
780	Example:	896	Example:
781		897
782	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	898	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783		899
784	This creates a new file in your home directory with the screen contents	900	This creates a new file in your home directory with the screen contents
785	everytime you hit C<Print>.	901	every time you hit C<Print>.
		902
		903	=item B<scrollstyle:> I<mode>
		904
		905	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		906	the author's favourite.
		907
		908	=item B<thickness:> I<number>
		909
		910	Set the scrollbar width in pixels.
786		911
787	=item B<scrollBar:> I<boolean>	912	=item B<scrollBar:> I<boolean>
788		913
789	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	914	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790	disable the scrollbar; option B<+sb>.	915	disable the scrollbar; option B<+sb>.
…		…
810	B<False>: do not scroll to bottom when tty receives output; option	935	B<False>: do not scroll to bottom when tty receives output; option
811	B<+si>.	936	B<+si>.
812		937
813	=item B<scrollWithBuffer:> I<boolean>	938	=item B<scrollWithBuffer:> I<boolean>
814		939
815	B<True>: scroll with scrollback buffer when tty receives new lines (and	940	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
816	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	941	try to show the same lines) and B<scrollTtyOutput> is False; option
817	with scrollback buffer when tty recieves new lines; option B<+sw>.	942	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		943	new lines; option B<+sw>.
818		944
819	=item B<scrollTtyKeypress:> I<boolean>	945	=item B<scrollTtyKeypress:> I<boolean>
820		946
821	B<True>: scroll to bottom when a non-special key is pressed. Special keys	947	B<True>: scroll to bottom when a non-special key is pressed. Special keys
822	are those which are intercepted by rxvt-unicode for special handling and	948	are those which are intercepted by rxvt-unicode for special handling and
…		…
853	=item B<termName:> I<termname>	979	=item B<termName:> I<termname>
854		980
855	Specifies the terminal type name to be set in the B<TERM> environment	981	Specifies the terminal type name to be set in the B<TERM> environment
856	variable; option B<-tn>.	982	variable; option B<-tn>.
857		983
858	=item B<linespace:> I<number>	984	=item B<lineSpace:> I<number>
859		985
860	Specifies number of lines (pixel height) to insert between each row of	986	Specifies number of lines (pixel height) to insert between each row of
861	the display [default 0]; option B<-lsp>.	987	the display [default 0]; option B<-lsp>.
862		988
863	=item B<meta8:> I<boolean>	989	=item B<meta8:> I<boolean>
…		…
877		1003
878	=item B<cursorBlink:> I<boolean>	1004	=item B<cursorBlink:> I<boolean>
879		1005
880	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1006	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
881	option B<-bc>.	1007	option B<-bc>.
		1008
		1009	=item B<cursorUnderline:> I<boolean>
		1010
		1011	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1012	option B<-uc>.
882		1013
883	=item B<pointerBlank:> I<boolean>	1014	=item B<pointerBlank:> I<boolean>
884		1015
885	B<True>: blank the pointer when a key is pressed or after a set number	1016	B<True>: blank the pointer when a key is pressed or after a set number
886	of seconds of inactivity. B<False>: the pointer is always visible	1017	of seconds of inactivity. B<False>: the pointer is always visible
…		…
900	large number (e.g. C<987654321>) to effectively disable the timeout.	1031	large number (e.g. C<987654321>) to effectively disable the timeout.
901		1032
902	=item B<backspacekey:> I<string>	1033	=item B<backspacekey:> I<string>
903		1034
904	The string to send when the backspace key is pressed. If set to B<DEC>	1035	The string to send when the backspace key is pressed. If set to B<DEC>
905	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1036	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
906	(code 8) - which can be reversed with the appropriate DEC private mode	1037	(code 8) - which can be reversed with the appropriate DEC private mode
907	escape sequence.	1038	escape sequence.
908		1039
909	=item B<deletekey:> I<string>	1040	=item B<deletekey:> I<string>
910		1041
…		…
915	=item B<cutchars:> I<string>	1046	=item B<cutchars:> I<string>
916		1047
917	The characters used as delimiters for double-click word selection	1048	The characters used as delimiters for double-click word selection
918	(whitespace delimiting is added automatically if resource is given).	1049	(whitespace delimiting is added automatically if resource is given).
919		1050
920	When the selection extension is in use (the default if compiled in, see	1051	When the perl selection extension is in use (the default if compiled
921	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1052	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
922	will be created (if the resource exists, otherwise, no regex will be	1053	characters will be created (if the resource exists, otherwise, no regex
923	created). In this mode, characters outside ISO-8859-1 can be used.	1054	will be created). In this mode, characters outside ISO-8859-1 can be used.
924		1055
925	When the selection extension is not used, only ISO-8859-1 characters can	1056	When the selection extension is not used, only ISO-8859-1 characters can
926	be used. If not specified, the built-in default is used:	1057	be used. If not specified, the built-in default is used:
927		1058
928	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1059	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
929		1060
930	=item B<preeditType:> I<style>	1061	=item B<preeditType:> I<style>
931		1062
932	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1063	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
933		1064
…		…
987		1118
988	Turn on/off secondary screen (default enabled).	1119	Turn on/off secondary screen (default enabled).
989		1120
990	=item B<secondaryScroll:> I<boolean>	1121	=item B<secondaryScroll:> I<boolean>
991		1122
992	Turn on/off secondary screen scroll (default enabled). If the this	1123	Turn on/off secondary screen scroll (default enabled). If this
993	option is enabled, scrolls on the secondary screen will change the	1124	option is enabled, scrolls on the secondary screen will change the
994	scrollback buffer and switching to/from the secondary screen will	1125	scrollback buffer and, when secondaryScreen is off, switching
995	instead scroll the screen up.	1126	to/from the secondary screen will instead scroll the screen up.
996		1127
997	=item B<hold>: I<boolean>	1128	=item B<hold>: I<boolean>
998		1129
999	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1130	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1000	will not immediately destroy its window when the program executed within	1131	will not immediately destroy its window when the program executed within
1001	it exits. Instead, it will wait till it is being killed or closed by the	1132	it exits. Instead, it will wait till it is being killed or closed by the
1002	user.	1133	user.
		1134
		1135	=item B<chdir>: I<path>
		1136
		1137	Sets the working directory for the shell (or the command specified via
		1138	B<-e>). The I<path> must be an absolute path and it must exist for
		1139	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1140	directory will be used; option B<-cd>.
1003		1141
1004	=item B<keysym.>I<sym>: I<string>	1142	=item B<keysym.>I<sym>: I<string>
1005		1143
1006	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1144	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1007	intervening resource name B<keysym.> cannot be omitted.	1145	intervening resource name B<keysym.> cannot be omitted.
…		…
1021	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1159	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1022	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1160	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1023	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1161	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1024	performed in an exact manner; however, the closest match is assured.	1162	performed in an exact manner; however, the closest match is assured.
1025		1163
1026	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1164	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1027	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1165	number), see RESOURCES in C<man 7 X> for further details.
1028	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1029	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1030	can start or end with whitespace.
1031
1032	Please note that you need to double the C<\> in resource files, as
1033	Xlib itself does its own de-escaping (you can use C<\033> instead of
1034	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1035	processing).
1036
1037	You can define a range of keysyms in one shot by providing a I<string>
1038	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1039	should be a character not used by the strings.
1040
1041	Its usage can be demonstrated by an example:
1042
1043	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
1044
1045	The above line is equivalent to the following three lines:
1046
1047	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1048	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1049	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1050		1166
1051	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1167	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1052	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1168	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1053	example the following means "change the current locale to C<zh_CN.GBK>	1169	example the following means "change the current locale to C<zh_CN.GBK>
1054	when Control-Meta-c is being pressed":	1170	when Control-Meta-c is being pressed":
1055		1171
1056	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1172	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1057		1173
1058	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1174	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1059	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1175	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1060	manpage. For example, the F<selection> extension (activated via	1176	manpage. For example, the F<selection> extension (activated via
1061	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1177	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1062		1178
1063	URxvt.keysym.M-C-c: perl:selection:rot13	1179	URxvt.keysym.M-C-c: perl:selection:rot13
1064		1180
1065	Due the the large number of modifier combinations, a defined key mapping	1181	Due the the large number of modifier combinations, a defined key mapping
1066	will match if at I<at least> the specified identifiers are being set, and	1182	will match if I<at least> the specified identifiers are being set, and
1067	no other key mappings with those and more bits are being defined. That	1183	no other key mappings with those and more bits are being defined. That
1068	means that defining a key map for C<a> will automatically provide	1184	means that defining a key map for C<a> will automatically provide
1069	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1185	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1070	mappings themselves.	1186	mappings themselves.
1071		1187
…		…
1107	example, C<default,-selection> will use all the default extension except	1223	example, C<default,-selection> will use all the default extension except
1108	C<selection>.	1224	C<selection>.
1109		1225
1110	Extension names can also be followed by an argument in angle brackets	1226	Extension names can also be followed by an argument in angle brackets
1111	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1227	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1228	searchable scrollback to Alt/Meta-s). Mentioning the same extension
1113	multiple times with different arguments will pass multiple arguments to	1229	multiple times with different arguments will pass multiple arguments to
1114	the extension.	1230	the extension.
1115		1231
1116	Each extension is looked up in the library directories, loaded if	1232	Each extension is looked up in the library directories, loaded if
1117	necessary, and bound to the current terminal instance.	1233	necessary, and bound to the current terminal instance.
…		…
1122	all instances, while B<perl-ext> is used for specific instances.	1238	all instances, while B<perl-ext> is used for specific instances.
1123		1239
1124	=item B<perl-eval>: I<string>	1240	=item B<perl-eval>: I<string>
1125		1241
1126	Perl code to be evaluated when all extensions have been registered. See	1242	Perl code to be evaluated when all extensions have been registered. See
1127	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1243	the @@RXVT_NAME@@perl(3) manpage.
1128	will be ignored when running setuid/setgid.
1129		1244
1130	=item B<perl-lib>: I<path>	1245	=item B<perl-lib>: I<path>
1131		1246
1132	Colon-separated list of additional directories that hold extension	1247	Colon-separated list of additional directories that hold extension
1133	scripts. When looking for extensions specified by the C<perl> resource,	1248	scripts. When looking for extensions specified by the C<perl> resource,
1134	@@RXVT_NAME@@ will first look in these directories and then in	1249	@@RXVT_NAME@@ will first look in these directories and then in
1135	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1250	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1136	will be ignored when running setuid/setgid.
1137		1251
1138	See the @@RXVT_NAME@@perl(3) manpage.	1252	See the @@RXVT_NAME@@perl(3) manpage.
1139		1253
1140	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1254	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1141		1255
…		…
1153	(default: C<M-s>).	1267	(default: C<M-s>).
1154		1268
1155	=item B<urlLauncher>: I<string>	1269	=item B<urlLauncher>: I<string>
1156		1270
1157	Specifies the program to be started with a URL argument. Used by the	1271	Specifies the program to be started with a URL argument. Used by the
1158	C<selection-popup> and C<mark-urls> perl extensions.	1272	C<selection-popup> and C<matcher> perl extensions.
1159		1273
1160	=item B<transient-for>: I<windowid>	1274	=item B<transient-for>: I<windowid>
1161		1275
1162	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1276	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163		1277
1164	=item B<override-redirect>: I<boolean>	1278	=item B<override-redirect>: I<boolean>
1165		1279
1166	Compile I<frills>: Sets override-redirect for the terminal window, making	1280	Compile I<frills>: Sets override-redirect for the terminal window, making
1167	it almost invisible to window managers; option B<-override-redirect>.	1281	it almost invisible to window managers; option B<-override-redirect>.
		1282
		1283	=item B<iso14755:> I<boolean>
		1284
		1285	Turn on/off ISO 14755 (default enabled).
		1286
		1287	=item B<iso14755_52:> I<boolean>
		1288
		1289	Turn on/off ISO 14755 5.2 mode (default enabled).
1168		1290
1169	=back	1291	=back
1170		1292
1171	=head1 THE SCROLLBAR	1293	=head1 THE SCROLLBAR
1172		1294
…		…
1191	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1313	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1192	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1314	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1193	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1315	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1194	respectively.	1316	respectively.
1195		1317
1196	=head1 TEXT SELECTION AND INSERTION	1318	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1197		1319
1198	The behaviour of text selection and insertion mechanism is similar to	1320	The behaviour of text selection and insertion/pasting mechanism is similar
1199	I<xterm>(1).	1321	to I<xterm>(1).
1200		1322
1201	=over 4	1323	=over 4
1202		1324
1203	=item B<Selection>:	1325	=item B<Selecting>:
1204		1326
1205	Left click at the beginning of the region, drag to the end of the region	1327	Left click at the beginning of the region, drag to the end of the region
1206	and release; Right click to extend the marked region; Left double-click	1328	and release; Right click to extend the marked region; Left double-click
1207	to select a word; Left triple-click to select the entire logical line	1329	to select a word; Left triple-click to select the entire logical line
1208	(which can span multiple screen lines), unless modified by resource	1330	(which can span multiple screen lines), unless modified by resource
…		…
1212	(Compile: I<frills>) will create a rectangular selection instead of a	1334	(Compile: I<frills>) will create a rectangular selection instead of a
1213	normal one. In this mode, every selected row becomes its own line in the	1335	normal one. In this mode, every selected row becomes its own line in the
1214	selection, and trailing whitespace is visually underlined and removed from	1336	selection, and trailing whitespace is visually underlined and removed from
1215	the selection.	1337	the selection.
1216		1338
1217	=item B<Insertion>:	1339	=item B<Pasting>:
1218		1340
1219	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1341	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1220	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1342	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1221	Meta modifier) to be inserted as if it had been typed on the keyboard.	1343	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1222		1344
1223	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1345	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224	inserted too.	1346	inserted too.
1225		1347
1226	=back	1348	=back
…		…
1243		1365
1244	=head1 ISO 14755 SUPPORT	1366	=head1 ISO 14755 SUPPORT
1245		1367
1246	ISO 14755 is a standard for entering and viewing unicode characters	1368	ISO 14755 is a standard for entering and viewing unicode characters
1247	and character codes using the keyboard. It consists of 4 parts. The	1369	and character codes using the keyboard. It consists of 4 parts. The
1248	first part is available rxvt-unicode has been compiled with	1370	first part is available if rxvt-unicode has been compiled with
1249	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1371	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1250	with C<--enable-iso14755>.	1372	with C<--enable-iso14755>.
1251		1373
1252	=over 4	1374	=over 4
1253		1375
…		…
1311	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1433	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1312	it can be seen via the I<who(1)> command, and can accept messages. To	1434	it can be seen via the I<who(1)> command, and can accept messages. To
1313	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1435	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1314	on some systems or setgid to root or to some other group on others.	1436	on some systems or setgid to root or to some other group on others.
1315		1437
1316	=head1 COLORS AND GRAPHICS	1438	=head1 COLOURS AND GRAPHICS
1317		1439
1318	In addition to the default foreground and background colours,	1440	In addition to the default foreground and background colours,
1319	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1441	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1320	high-intensity bold/blink versions of the same). Here is a list of the	1442	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1321	colours with their names.	1443	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1444	cube plus a 8 (24) colour greyscale ramp.
		1445
		1446	Here is a list of the ANSI colours with their names.
1322		1447
1323	=begin table	1448	=begin table
1324		1449
1325	B<color0> (black) = Black	1450	B<color0> (black) = Black
1326	B<color1> (red) = Red3	1451	B<color1> (red) = Red3
…		…
1346	It is also possible to specify the colour values of B<foreground>,	1471	It is also possible to specify the colour values of B<foreground>,
1347	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1472	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1348	a number 0-15, as a convenient shorthand to reference the colour name of	1473	a number 0-15, as a convenient shorthand to reference the colour name of
1349	color0-color15.	1474	color0-color15.
1350		1475
1351	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1476	The following text gives values for the standard 88 colour mode (and
1352	additional 72 colours. The first 64 of those (with indices 16 to 79)	1477	values for the 256 colour mode in parentheses).
1353	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1354	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1355		1478
		1479	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1480
		1481	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1482	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1483
		1484	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1485	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1486	the RGB cube.
		1487
1356	Together, all those colours implement the 88 colour xterm colours. Only	1488	Together, all those colours implement the 88 (256) colour xterm
1357	the first 16 can be changed using resources currently, the rest can only	1489	colours. Only the first 16 can be changed using resources currently, the
1358	be changed via command sequences ("escape codes").	1490	rest can only be changed via command sequences ("escape codes").
		1491
		1492	Applications are advised to use terminfo or command sequences to discover
		1493	number and RGB values of all colours (yes, you can query this...).
1359		1494
1360	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1495	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1361	always swapping the foreground/background colours. This is in contrast to	1496	always swapping the foreground/background colours. This is in contrast to
1362	I<xterm>(1) where the colours are only swapped if they have not otherwise	1497	I<xterm>(1) where the colours are only swapped if they have not otherwise
1363	been specified. For example,	1498	been specified. For example,
1364		1499
		1500	@@RXVT_NAME@@ -fg Black -bg White -rv
		1501
		1502	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1503	White.
		1504
		1505	=head2 ALPHA CHANNEL SUPPORT
		1506
		1507	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1508	their act together, rxvt-unicode will do it's own alpha channel management:
		1509
		1510	You can prefix any colour with an opaqueness percentage enclosed in
		1511	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1512	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1513	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1514	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1515	is the recommended format to specify transparency values, and works with
		1516	all ways to specify a colour.
		1517
		1518	For complete control, rxvt-unicode also supports
		1519	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1520	specifications, where the additional C<aaaa> component specifies opacity
		1521	(alpha) values. The minimum value of C<0000> is completely transparent,
		1522	while C<ffff> is completely opaque). The two example colours from
		1523	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1524	C<rgba:0000/ff00/0000/f332>.
		1525
		1526	You probably need to specify B<"-depth 32">, too, to force a visual with
		1527	alpha channels, and have the luck that your X-server uses ARGB pixel
		1528	layout, as X is far from just supporting ARGB visuals out of the box, and
		1529	rxvt-unicode just fudges around.
		1530
		1531	For example, the following selects an almost completely transparent black
		1532	background, and an almost opaque pink foreground:
		1533
		1534	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1535
		1536	When not using a background image, then the interpretation of the
		1537	alpha channel is up to your compositing manager (most interpret it as
		1538	transparency of course).
		1539
		1540	When using a background pixmap or pseudo-transparency, then the background
		1541	colour will always behave as if it were completely transparent (so the
		1542	background image shows instead), regardless of how it was specified, while
		1543	other colours will either be transparent as specified (the background
		1544	image will show through) on servers supporting the RENDER extension, or
		1545	fully opaque on servers not supporting the RENDER EXTENSION.
		1546
		1547	Please note that due to bugs in Xft, specifying alpha values might result
		1548	in garbage being displayed when the X-server does not support the RENDER
		1549	extension.
		1550
		1551	=head1 ENVIRONMENT
		1552
		1553	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1554
1365	=over 4	1555	=over 4
1366		1556
1367	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1368
1369	would yield White on Black, while on I<xterm>(1) it would yield Black
1370	on White.
1371
1372	=back
1373
1374	=head2 ALPHA CHANNEL SUPPORT
1375
1376	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1377	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1378	(recommended, but B<MUST> have 4 digits/component) colour specifications,
1379	in addition to the ones provided by X, where the additional A component
1380	specifies opacity (alpha) values. The minimum value of C<0> is completely
1381	transparent). You can also prefix any color with C<[a]>, where C<a> is on
1382	to four hex digits specifiying the opacity value.
1383
1384	You probably need to specify B<"-depth 32">, too, and have the luck that
1385	your X-server uses ARGB pixel layout, as X is far from just supporting
1386	ARGB visuals out of the box, and rxvt-unicode just fudges around.
1387
1388	For example, the following selects an almost completely transparent red
1389	background, and an almost opaque pink foreground:
1390
1391	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1392
1393	I<Please note that transparency of any kind if completely unsupported by
1394	the author. Don't bug him with installation questions!>
1395
1396	=head1 ENVIRONMENT
1397
1398	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1399
1400	=over 4
1401
1402	=item B<TERM>	1557	=item B<TERM>
1403		1558
1404	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1559	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1405	resources or on the commandline.	1560	resources or on the command line.
1406		1561
1407	=item B<COLORTERM>	1562	=item B<COLORTERM>
1408		1563
1409	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1564	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1410	compiled with XPM support, and optionally with the added extension	1565	compiled with background image support, and optionally with the added
1411	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1566	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1567	screen.
1412		1568
1413	=item B<COLORFGBG>	1569	=item B<COLORFGBG>
1414		1570
1415	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1571	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1416	the colour code used as default foreground/text colour (or the string	1572	the colour code used as default foreground/text colour (or the string
1417	C<default> to indicate that the default-colour escape sequence is to be	1573	C<default> to indicate that the default-colour escape sequence is to be
1418	used), C<bg> is the colour code used as default background colour (or the	1574	used), C<bg> is the colour code used as default background colour (or the
1419	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1575	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1420	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1576	was compiled with background image support. Libraries like C<ncurses>
1421	(and do) use this information to optimize screen output.	1577	and C<slang> can (and do) use this information to optimize screen output.
1422		1578
1423	=item B<WINDOWID>	1579	=item B<WINDOWID>
1424		1580
1425	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1581	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1426	window, which usually has subwindows for the scrollbar, the terminal	1582	window, which usually has subwindows for the scrollbar, the terminal
…		…
1432	C<--with-terminfo=PATH>.	1588	C<--with-terminfo=PATH>.
1433		1589
1434	=item B<DISPLAY>	1590	=item B<DISPLAY>
1435		1591
1436	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1592	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1437	display in its child processes.	1593	display in its child processes if C<-display> isn't used to override. It
		1594	defaults to C<:0> if it doesn't exist.
1438		1595
1439	=item B<SHELL>	1596	=item B<SHELL>
1440		1597
1441	The shell to be used for command execution, defaults to C</bin/sh>.	1598	The shell to be used for command execution, defaults to C</bin/sh>.
1442		1599
1443	=item B<RXVT_SOCKET>	1600	=item B<RXVT_SOCKET>
1444		1601
1445	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1602	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1446	@@RXVT_NAME@@d(1).	1603	@@RXVT_NAME@@d(1).
1447		1604
1448	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1605	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1449		1606
1450	=item B<HOME>	1607	=item B<HOME>
1451		1608
1452	Used to locate the default directory for the unix domain socket for	1609	Used to locate the default directory for the unix domain socket for
1453	daemon communications and to locate various resource files (such as	1610	daemon communications and to locate various resource files (such as
1454	C<.Xdefaults>)	1611	C<.Xdefaults>)
1455		1612
1456	=item B<XAPPLRESDIR>	1613	=item B<XAPPLRESDIR>
1457		1614
1458	Directory where various X resource files are being located.	1615	Directory where application-specific X resource files are located.
1459		1616
1460	=item B<XENVIRONMENT>	1617	=item B<XENVIRONMENT>
1461		1618
1462	If set and accessible, gives the name of a X resource file to be loaded by	1619	If set and accessible, gives the name of a X resource file to be loaded by
1463	@@RXVT_NAME@@.	1620	@@RXVT_NAME@@.
…		…
1468		1625
1469	=over 4	1626	=over 4
1470		1627
1471	=item B</usr/lib/X11/rgb.txt>	1628	=item B</usr/lib/X11/rgb.txt>
1472		1629
1473	Color names.	1630	Colour names.
1474		1631
1475	=back	1632	=back
1476		1633
1477	=head1 SEE ALSO	1634	=head1 SEE ALSO
1478		1635
…		…
1517	Project Coordinator (changes.txt 2.21a to 2.4.5)	1674	Project Coordinator (changes.txt 2.21a to 2.4.5)
1518		1675
1519	=item Geoff Wing L<< <gcw@pobox.com> >>	1676	=item Geoff Wing L<< <gcw@pobox.com> >>
1520		1677
1521	Rewrote screen display and text selection routines.	1678	Rewrote screen display and text selection routines.
1522		1679
1523	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1680	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1524		1681
1525	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1682	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1526		1683
1527	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1684	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1529		1686
1530	Project Coordinator (Changes 1.0 -)	1687	Project Coordinator (Changes 1.0 -)
1531		1688
1532	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1689	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1533		1690
1534	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1691	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1535		1692
1536	=back	1693	=back
1537		1694

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.116 by root, Mon Jul 10 04:03:09 2006 UTC vs. Revision 1.196 by root, Fri May 6 10:18:00 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.116 by root, Mon Jul 10 04:03:09 2006 UTC vs.
Revision 1.196 by root, Fri May 6 10:18:00 2011 UTC