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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.79 by root, Mon Jan 2 20:40:20 2006 UTC vs.
Revision 1.140 by sasha, Fri Oct 26 18:27:29 2007 UTC

…		…
17	=head1 FREQUENTLY ASKED QUESTIONS	17	=head1 FREQUENTLY ASKED QUESTIONS
18		18
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	19	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	20	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	21	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>.	22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23		23
24	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
25		25
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	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	27	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	28	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	29	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	30	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are left-to-right scripts, such	33	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	36	such as cursor-movement while editing -- break otherwise), but that might
37	change.	37	change.
38		38
39	If you are looking for a terminal that supports more exotic scripts, let	39	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	40	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	41	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	42	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	43	another for japanese.
44		44
45	Therefore another design rationale was the use of multiple fonts to	45	Therefore another design rationale was the use of multiple fonts to
46	display characters: The idea of a single unicode font which many other	46	display characters: The idea of a single unicode font which many other
47	programs force onto it's users never made sense to me: You should be able	47	programs force onto its users never made sense to me: You should be able
48	to choose any font for any script freely.	48	to choose any font for any script freely.
49		49
50	Apart from that, rxvt-unicode is also much better internationalised than	50	Apart from that, rxvt-unicode is also much better internationalised than
51	it's predecessor, supports things such as XFT and ISO 14755 that are handy	51	its predecessor, supports things such as XFT and ISO 14755 that are handy
52	in i18n-environments, is faster, and has a lot less bugs than the original	52	in i18n-environments, is faster, and has a lot bugs less than the original
53	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
54		54
55	It is still faithfully following the original rxvt idea of being lean	55	It is still faithfully following the original rxvt idea of being lean
56	and nice on resources: for example, you can still configure rxvt-unicode	56	and nice on resources: for example, you can still configure rxvt-unicode
57	without most of it's features to get a lean binary. It also comes with	57	without most of its features to get a lean binary. It also comes with
58	a client/daemon pair that lets you open any number of terminal windows	58	a client/daemon pair that lets you open any number of terminal windows
59	from within a single process, which makes startup time very fast and	59	from within a single process, which makes startup time very fast and
60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
62		62
63	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65	reference documentation (escape sequences etc.).	65	reference documentation (escape sequences etc.).
66		66
67	=head1 OPTIONS	67	=head1 OPTIONS
68		68
69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
93		93
94	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
95	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
96	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
97		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<xft>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
98	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
99		104
100	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
101		106
102	=item B<-rv>\|B<+rv>	107	=item B<-rv>\|B<+rv>
103		108
104	Turn on/off simulated reverse video; resource B<reverseVideo>.	109	Turn on/off simulated reverse video; resource B<reverseVideo>.
105		110
106	=item B<-j>\|B<+j>	111	=item B<-j>\|B<+j>
107		112
108	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109		114
110	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	115	=item B<-ss>\|B<+ss>
111		116
112	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113	B<-tr>; resource B<inheritPixmap>.	118
		119	=item B<-tr>\|B<+tr>
		120
		121	Turn on/off illusion of a transparent window background. Obsolete form of it is
		122	B<-ip> and it should not be used anymore; resource B<transparent>.
		123
		124	I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
		125	changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
		126	be phased out in future versions of rxvt!>
		127
		128	I<Please address all transparency related issues to Sasha Vasko at
		129	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114		130
115	=item B<-fade> I<number>	131	=item B<-fade> I<number>
116		132
117	Fade the text by the given percentage when focus is lost. Small values	133	Fade the text by the given percentage when focus is lost. Small values
118	fade a little only, 100 completely replaces all colours by the fade	134	fade a little only, 100 completely replaces all colours by the fade
119	colour; resource B<fading>.	135	colour; resource B<fading>.
120		136
121	=item B<-fadecolor> I<colour>	137	=item B<-fadecolor> I<colour>
122		138
123	Fade to this colour when fading is used (see B<-fade>). The default colour	139	Fade to this colour when fading is used (see B<-fade>). The default colour
124	is black. resource B<fadeColor>.	140	is opaque black. resource B<fadeColor>.
125		141
126	=item B<-tint> I<colour>	142	=item B<-tint> I<colour>
127		143
128	Tint the transparent background pixmap with the given colour when	144	Tint the transparent background pixmap with the given colour when
129	transparency is enabled with B<-tr> or B<-ip>. This only works for	145	transparency is enabled with B<-tr>. This only works for
130	non-tiled backgrounds, currently. See also the B<-sh> option that can be	146	non-tiled backgrounds, currently. See also the B<-sh> option that can be
131	used to brighten or darken the image in addition to tinting it; resource	147	used to brighten or darken the image in addition to tinting it.
		148	Please note that certain tint colours can be applied on the server-side,
		149	thus yielding performance gain of two orders of magnitude. These colours are:
		150	blue, red, green, cyan, magenta, yellow, and those close to them; resource
132	I<tintColor>. Example:	151	I<tintColor>. Example:
133		152
134	@@RXVT_NAME@@ -tr -tint blue -sh 40	153	@@RXVT_NAME@@ -tr -tint blue -sh 40
135		154
136	=item B<-sh>	155	=item B<-sh> I<number>
137		156
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	157	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
139	background image in addition to tinting it (i.e. B<-tint> must be	158	background image in addition to (or instead of) tinting it;
140	specified, too, e.g. C<-tint white>).	159	resource I<shading>.
		160
		161	=item B<-blt> I<string>
		162
		163	Specify background blending type. If background pixmap is specified
		164	at the same time as transparency - such pixmap will be blended over
		165	transparency image, using method specified. Supported values are :
		166	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		167	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		168	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		169	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		170
		171	=item B<-blr> I<HxV>
		172
		173	Apply Gaussian Blur with the specified radii to the transparent
		174	background image. If single number is specified - both vertical and
		175	horizontal radii are considered to be the same. Setting one of the
		176	radii to 1 and another to a large number creates interesting effects
		177	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		178	resource I<blurRadius>.
141		179
142	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
143		181
144	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
145		183
…		…
147		185
148	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
149		187
150	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;geom]>
151		189
152	Compile I<XPM>: Specify XPM file for the background and also optionally	190	Compile I<afterimage>: Specify image file for the background and also
153	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
154	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
155	command-line; resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
156		194
157	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
158		196
159	The cursor colour; resource B<cursorColor>.	197	The cursor colour; resource B<cursorColor>.
160		198
…		…
172	resource B<borderColor>.	210	resource B<borderColor>.
173		211
174	=item B<-fn> I<fontlist>	212	=item B<-fn> I<fontlist>
175		213
176	Select the fonts to be used. This is a comma separated list of font names	214	Select the fonts to be used. This is a comma separated list of font names
177	that are used in turn when trying to display Unicode characters. The	215	that are checked in order when trying to find glyphs for characters. The
178	first font defines the cell size for characters; other fonts might be	216	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	217	smaller, but not (in general) larger. A (hopefully) reasonable default
180	font list is always appended to it. See resource B<font> for more details.	218	font list is always appended to it. See resource B<font> for more details.
181		219
182	In short, to specify an X11 core font, just specify it's name or prefix it	220	In short, to specify an X11 core font, just specify its name or prefix it
183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	221	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	222	e.g.:
185		223
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	224	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	225	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	227	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190	section of @@RXVT_NAME@@(7).	228	section of @@RXVT_NAME@@(7).
191		229
192	=item B<-fb> I<fontlist>	230	=item B<-fb> I<fontlist>
193		231
194	Compile font-styles: The bold font list to use when bold characters are to	232	Compile I<font-styles>: The bold font list to use when B<bold> characters
195	be printed. See resource B<boldFont> for details.	233	are to be printed. See resource B<boldFont> for details.
196		234
197	=item B<-fi> I<fontlist>	235	=item B<-fi> I<fontlist>
198		236
199	Compile font-styles: The italic font list to use when bold characters are to	237	Compile I<font-styles>: The italic font list to use when I<italic>
200	be printed. See resource B<italicFont> for details.	238	characters are to be printed. See resource B<italicFont> for details.
201		239
202	=item B<-fbi> I<fontlist>	240	=item B<-fbi> I<fontlist>
203		241
204	Compile font-styles: The bold italic font list to use when bold characters are to	242	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205	be printed. See resource B<boldItalicFont> for details.	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
		244	for details.
206		245
207	=item B<-is>\|B<+is>	246	=item B<-is>\|B<+is>
208		247
209	Compile font-styles: Bold/Italic font styles imply high intensity	248	Compile I<font-styles>: Bold/Italic font styles imply high intensity
210	foreground/background (default). See resource B<intensityStyles> for	249	foreground/background (default). See resource B<intensityStyles> for
211	details.	250	details.
212		251
213	=item B<-name> I<name>	252	=item B<-name> I<name>
214		253
…		…
296		335
297	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	336	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
298	if honoured by the WM, the rxvt-unicode window will not have window	337	if honoured by the WM, the rxvt-unicode window will not have window
299	decorations; resource B<borderLess>.	338	decorations; resource B<borderLess>.
300		339
		340	=item B<-override-redirect>
		341
		342	Compile I<frills>: Sets override-redirect on the window; resource
		343	B<override-redirect>.
		344
		345	=item B<-sbg>
		346
		347	Compile I<frills>: Disable the usage of the built-in block graphics/line
		348	drawing characters and just rely on what the specified fonts provide. Use
		349	this if you have a good font and want to use its block graphic glyphs;
		350	resource B<skipBuiltinGlyphs>.
		351
301	=item B<-lsp> I<number>	352	=item B<-lsp> I<number>
302		353
303	Compile I<frills>: Lines (pixel height) to insert between each row of	354	Compile I<frills>: Lines (pixel height) to insert between each row of
304	the display. Useful to work around font rendering problems; resource	355	the display. Useful to work around font rendering problems; resource
305	B<linespace>.	356	B<lineSpace>.
306		357
307	=item B<-tn> I<termname>	358	=item B<-tn> I<termname>
308		359
309	This option specifies the name of the terminal type to be set in the	360	This option specifies the name of the terminal type to be set in the
310	B<TERM> environment variable. This terminal type must exist in the	361	B<TERM> environment variable. This terminal type must exist in the
…		…
364	for more info.	415	for more info.
365		416
366	=item B<-tcw>	417	=item B<-tcw>
367		418
368	Change the meaning of triple-click selection with the left mouse	419	Change the meaning of triple-click selection with the left mouse
		420	button. Only effective when the original (non-perl) selection code is
369	button. Instead of selecting a full line it will extend the selection the	421	in-use. Instead of selecting a full line it will extend the selection the
370	end of the logical line only. resource B<tripleclickwords>.	422	end of the logical line only. resource B<tripleclickwords>.
371		423
372	=item B<-insecure>	424	=item B<-insecure>
373		425
374	Enable "insecure" mode, which currently enables most of the escape	426	Enable "insecure" mode, which currently enables most of the escape
…		…
402		454
403	Remap a key symbol. See resource B<keysym>.	455	Remap a key symbol. See resource B<keysym>.
404		456
405	=item B<-embed> I<windowid>	457	=item B<-embed> I<windowid>
406		458
407	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	459	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
408	which enables applications to easily embed a terminal.	460	which enables applications to easily embed a terminal.
409		461
410	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	462	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
411	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	463	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
412	quite a bit, so don't expect it to keep some specific state. It's best to	464	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
415	The window will not be destroyed when @@RXVT_NAME@@ exits.	467	The window will not be destroyed when @@RXVT_NAME@@ exits.
416		468
417	It might be useful to know that @@RXVT_NAME@@ will not close file	469	It might be useful to know that @@RXVT_NAME@@ will not close file
418	descriptors passed to it (except for stdin/out/err, of course), so you	470	descriptors passed to it (except for stdin/out/err, of course), so you
419	can use file descriptors to communicate with the programs within the	471	can use file descriptors to communicate with the programs within the
420	terminal. This works regardless of wether the C<-embed> option was used or	472	terminal. This works regardless of whether the C<-embed> option was used or
421	not.	473	not.
422		474
423	Here is a short Gtk2-perl snippet that illustrates how this option can be	475	Here is a short Gtk2-perl snippet that illustrates how this option can be
424	used (a longer example is in F<doc/embed>):	476	used (a longer example is in F<doc/embed>):
425		477
…		…
427	$rxvt->signal_connect_after (realize => sub {	479	$rxvt->signal_connect_after (realize => sub {
428	my $xid = $_[0]->window->get_xid;	480	my $xid = $_[0]->window->get_xid;
429	system "@@RXVT_NAME@@ -embed $xid &";	481	system "@@RXVT_NAME@@ -embed $xid &";
430	});	482	});
431		483
432	=item B<-pty-fd> I<fileno>	484	=item B<-pty-fd> I<file descriptor>
433		485
434	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	486	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
435	pair but instead use the given filehandle as the tty master. This is	487	pair but instead use the given file descriptor as the tty master. This is
436	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	488	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
437	without having to run a program within it.	489	without having to run a program within it.
438		490
439	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	491	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
440	entries and will not tinker with pty/tty permissions - you have to do that	492	entries and will not tinker with pty/tty permissions - you have to do that
441	yourself if you want that.	493	yourself if you want that.
		494
		495	As an extremely special case, specifying C<-1> will completely suppress
		496	pty/tty operations.
442		497
443	Here is a example in perl that illustrates how this option can be used (a	498	Here is a example in perl that illustrates how this option can be used (a
444	longer example is in F<doc/pty-fd>):	499	longer example is in F<doc/pty-fd>):
445		500
446	use IO::Pty;	501	use IO::Pty;
…		…
455	my $slave = $pty->slave;	510	my $slave = $pty->slave;
456	while (<$slave>) { print $slave "got <$_>\n" }	511	while (<$slave>) { print $slave "got <$_>\n" }
457		512
458	=item B<-pe> I<string>	513	=item B<-pe> I<string>
459		514
460	Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.	515	Comma-separated list of perl extension scripts to use (or not to use) in
		516	this terminal instance. See resource B<perl-ext> for details.
461		517
462	=back	518	=back
463		519
464	=head1 RESOURCES (available also as long-options)	520	=head1 RESOURCES (available also as long-options)
465		521
466	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	522	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
467	options) compiled into your version.	523	options) compiled into your version.
468		524
469	There are two different methods that @@RXVT_NAME@@ can use to get the	525	You can set and change the resources using X11 tools like B<xrdb>. Many
470	Xresource data: using the X libraries (Xrm*-functions) or internal	526	distribution do also load settings from the B<~/.Xresources> file when X
471	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	527	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
472	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	528	with later settings overwriting earlier ones:
473	resources using X11 tools like B<xrdb>. Many distribution do also load
474	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
475	will consult the following files/resources in order, with later settings
476	overwriting earlier ones:
477		529
478	1. system-wide app-defaults file, either locale-dependent OR global	530	1. system-wide app-defaults file, either locale-dependent OR global
479	2. app-defaults file in $XAPPLRESDIR	531	2. app-defaults file in $XAPPLRESDIR
480	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	532	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
481	4. SCREEN_RESOURCES for the current screen	533	4. SCREEN_RESOURCES for the current screen
482	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	534	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
483		535
484	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
485	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
486	set in XAPPLOADDIR/URxvt (compile-time defined: usually
487	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
488	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
489	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	536	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
490	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	537	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
491	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	538	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
492	easily configured, while the class name B<URxvt> allows resources	539	configured, while the class name B<URxvt> allows resources unique to
493	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	540	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
494	shared between different B<@@RXVT_NAME@@> configurations. If no	541	configurations. If no resources are specified, suitable defaults will
495	resources are specified, suitable defaults will be used. Command-line	542	be used. Command-line arguments can be used to override resource
496	arguments can be used to override resource settings. The following	543	settings. The following resources are supported (you might want to
497	resources are allowed:	544	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		545	extensions not documented here):
498		546
499	=over 4	547	=over 4
		548
		549	=item B<depth:> I<bitdepth>
		550
		551	Compile I<xft>: Attempt to find a visual with the given bit depth;
		552	option B<-depth>.
500		553
501	=item B<geometry:> I<geom>	554	=item B<geometry:> I<geom>
502		555
503	Create the window with the specified X window geometry [default 80x24];	556	Create the window with the specified X window geometry [default 80x24];
504	option B<-geometry>.	557	option B<-geometry>.
…		…
541	Use the specified colour to display underlined characters when the	594	Use the specified colour to display underlined characters when the
542	foreground colour is the default.	595	foreground colour is the default.
543		596
544	=item B<colorRV:> I<colour>	597	=item B<colorRV:> I<colour>
545		598
546	Use the specified colour as the background for reverse video	599	Use the specified colour as the background for reverse video characters
547	characters.	600	when OPTION_HC is disabled (--disable-frills).
548		601
549	=item B<underlineColor:> I<colour>	602	=item B<underlineColor:> I<colour>
550		603
551	If set, use the specified colour as the colour for the underline	604	If set, use the specified colour as the colour for the underline
552	itself. If unset, use the foreground colour.	605	itself. If unset, use the foreground colour.
…		…
568	option B<-rv>. B<False>: regular screen colours [default]; option	621	option B<-rv>. B<False>: regular screen colours [default]; option
569	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	622	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
570		623
571	=item B<jumpScroll:> I<boolean>	624	=item B<jumpScroll:> I<boolean>
572		625
573	B<True>: specify that jump scrolling should be used. When scrolling	626	B<True>: specify that jump scrolling should be used. When receiving lots
574	quickly, fewer screen updates are performed [default]; option B<-j>.	627	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		628	has been read, resulting in fewer updates while still displaying every
		629	received line; option B<-j>.
		630
575	B<False>: specify that smooth scrolling should be used; option B<+j>.	631	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		632	force a screen refresh on each new line it received; option B<+j>.
		633
		634	=item B<skipScroll:> I<boolean>
		635
		636	B<True>: (the default) specify that skip scrolling should be used. When
		637	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
		638	(around 60 times per second), resulting in far fewer updates. This can
		639	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		640	option B<-ss>.
		641
		642	B<False>: specify that everything is to be displayed, even
		643	if the refresh is too fast for the human eye to read anything (or the
		644	monitor to display anything); option B<+ss>.
576		645
577	=item B<inheritPixmap:> I<boolean>	646	=item B<inheritPixmap:> I<boolean>
578		647
579	B<True>: make the background inherit the parent windows' pixmap, giving	648	B<True>: make the background inherit the parent windows' pixmap, giving
580	artificial transparency. B<False>: do not inherit the parent windows'	649	artificial transparency. B<False>: do not inherit the parent windows'
581	pixmap.	650	pixmap.
582		651
		652	I<Please note that transparency of any kind if completely unsupported by
		653	the author. Don't bug him with installation questions!>
		654
583	=item B<fading:> I<number>	655	=item B<fading:> I<number>
584		656
585	Fade the text by the given percentage when focus is lost; option B<-fade>.	657	Fade the text by the given percentage when focus is lost; option B<-fade>.
586		658
587	=item B<fadeColor:> I<colour>	659	=item B<fadeColor:> I<colour>
…		…
594	Tint the transparent background pixmap with the given colour; option	666	Tint the transparent background pixmap with the given colour; option
595	B<-tint>.	667	B<-tint>.
596		668
597	=item B<shading:> I<number>	669	=item B<shading:> I<number>
598		670
599	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	671	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
600	image in addition to tinting it.	672	in addition to tinting it; option B<-sh>.
		673
		674	=item B<blendType:> I<string>
		675
		676	Specify background blending type; option B<-blt>.
		677
		678	=item B<blurRadius:> I<number>
		679
		680	Apply Gaussian Blurr with the specified radius to the transparent
		681	background image; option B<-blr>.
601		682
602	=item B<scrollColor:> I<colour>	683	=item B<scrollColor:> I<colour>
603		684
604	Use the specified colour for the scrollbar [default #B2B2B2].	685	Use the specified colour for the scrollbar [default #B2B2B2].
605		686
…		…
613	The colour of the border around the text area and between the scrollbar	694	The colour of the border around the text area and between the scrollbar
614	and the text.	695	and the text.
615		696
616	=item B<backgroundPixmap:> I<file[;geom]>	697	=item B<backgroundPixmap:> I<file[;geom]>
617		698
618	Use the specified XPM file (note the `.xpm' extension is optional) for	699	Use the specified image file for the background and also optionally
619	the background and also optionally specify its scaling with a geometry	700	specify its scaling with a geometry string B<WxH+X+Y>,
620	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	701	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
621	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	702	and B<"X" / "Y"> locate the image centre (percent).
622	centre (percent). A scale of 0 displays the image with tiling. A scale	703	A scale of 0 displays the image with tiling. A scale of 1 displays the
623	of 1 displays the image without any scaling. A scale of 2 to 9	704	image without any scaling. A scale of 2 to 9 specifies an integer
624	specifies an integer number of images in that direction. No image will	705	number of images in that direction. No image will be magnified beyond
625	be magnified beyond 10 times its original size. The maximum permitted	706	10 times its original size. The maximum permitted scale is 1000.
626	scale is 1000. [default 0x0+50+50]	707	Special string of B<"auto"> used as a geometry will cause image to be
627		708	automatically scaled to match window size.
628	=item B<menu:> I<file[;tag]>	709	If used in conjunction with B<-tr> option - specified pixmap will be
629		710	blended over transparency image using either alpha-blending, or any
630	Read in the specified menu file (note the `.menu' extension is	711	other blending type, specified with B<-blt "type"> option.
631	optional) and also optionally specify a starting tag to find. See the	712	[default 0x0+50+50]
632	reference documentation for details on the syntax for the menuBar.
633		713
634	=item B<path:> I<path>	714	=item B<path:> I<path>
635		715
636	Specify the colon-delimited search path for finding files (XPM and	716	Specify the colon-delimited search path for finding background image files.
637	menus), in addition to the paths specified by the B<RXVTPATH> and
638	B<PATH> environment variables.
639		717
640	=item B<font:> I<fontlist>	718	=item B<font:> I<fontlist>
641		719
642	Select the fonts to be used. This is a comma separated list of font	720	Select the fonts to be used. This is a comma separated list of font names
643	names that are used in turn when trying to display Unicode characters.	721	that are checked in order when trying to find glyphs for characters. The
644	The first font defines the cell size for characters; other fonts might	722	first font defines the cell size for characters; other fonts might be
645	be smaller, but not larger. A reasonable default font list is always	723	smaller, but not (in general) larger. A (hopefully) reasonable default
646	appended to it; option B<-fn>.	724	font list is always appended to it; option B<-fn>.
647		725
648	Each font can either be a standard X11 core font (XLFD) name, with	726	Each font can either be a standard X11 core font (XLFD) name, with
649	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	727	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
650		728
651	In addition, each font can be prefixed with additional hints and	729	In addition, each font can be prefixed with additional hints and
…		…
653	hint currently is C<codeset=codeset-name>, and this is only used for Xft	731	hint currently is C<codeset=codeset-name>, and this is only used for Xft
654	fonts.	732	fonts.
655		733
656	For example, this font resource	734	For example, this font resource
657		735
658	URxvt*font: 9x15bold,\	736	URxvt.font: 9x15bold,\
659	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	737	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
660	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	738	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
661	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	739	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
662	xft:Code2000:antialias=false	740	xft:Code2000:antialias=false
663		741
…		…
701		779
702	=item B<intensityStyles:> I<boolean>	780	=item B<intensityStyles:> I<boolean>
703		781
704	When font styles are not enabled, or this option is enabled (B<True>,	782	When font styles are not enabled, or this option is enabled (B<True>,
705	option B<-is>, the default), bold and italic font styles imply high	783	option B<-is>, the default), bold and italic font styles imply high
706	intensity foreground/backround colours. Disabling this option (B<False>,	784	intensity foreground/background colours. Disabling this option (B<False>,
707	option B<+is>) disables this behaviour, the high intensity colours are not	785	option B<+is>) disables this behaviour, the high intensity colours are not
708	reachable.	786	reachable.
709		787
710	=item B<selectstyle:> I<mode>	788	=item B<selectstyle:> I<mode>
711		789
712	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	790	Set mouse selection style to B<old> which is 2.20, B<oldword> which
713	xterm style with 2.20 old word selection, or anything else which gives	791	is xterm style with 2.20 old word selection, or anything else which
714	xterm style selection.	792	gives xterm style selection. Only effective when the original (non-perl)
		793	selection code is in use.
715		794
716	=item B<scrollstyle:> I<mode>	795	=item B<scrollstyle:> I<mode>
717		796
718	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	797	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
719	the author's favourite.	798	the author's favourite.
…		…
733	=item B<mapAlert:> I<boolean>	812	=item B<mapAlert:> I<boolean>
734		813
735	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	814	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
736	de-iconify (map) on receipt of a bell character [default].	815	de-iconify (map) on receipt of a bell character [default].
737		816
		817	=item B<urgentOnBell:> I<boolean>
		818
		819	B<True>: set the urgency hint for the wm on receipt of a bell character.
		820	B<False>: do not set the urgency hint [default].
		821
738	=item B<visualBell:> I<boolean>	822	=item B<visualBell:> I<boolean>
739		823
740	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	824	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
741	B<False>: no visual bell [default]; option B<+vb>.	825	B<False>: no visual bell [default]; option B<+vb>.
742		826
…		…
760		844
761	The string will be interpreted as if typed into the shell as-is.	845	The string will be interpreted as if typed into the shell as-is.
762		846
763	Example:	847	Example:
764		848
765	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	849	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
766		850
767	This creates a new file in your home directory with the screen contents	851	This creates a new file in your home directory with the screen contents
768	everytime you hit C<Print>.	852	every time you hit C<Print>.
769		853
770	=item B<scrollBar:> I<boolean>	854	=item B<scrollBar:> I<boolean>
771		855
772	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	856	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
773	disable the scrollbar; option B<+sb>.	857	disable the scrollbar; option B<+sb>.
…		…
795		879
796	=item B<scrollWithBuffer:> I<boolean>	880	=item B<scrollWithBuffer:> I<boolean>
797		881
798	B<True>: scroll with scrollback buffer when tty receives new lines (and	882	B<True>: scroll with scrollback buffer when tty receives new lines (and
799	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	883	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
800	with scrollback buffer when tty recieves new lines; option B<+sw>.	884	with scrollback buffer when tty receives new lines; option B<+sw>.
801		885
802	=item B<scrollTtyKeypress:> I<boolean>	886	=item B<scrollTtyKeypress:> I<boolean>
803		887
804	B<True>: scroll to bottom when a non-special key is pressed. Special keys	888	B<True>: scroll to bottom when a non-special key is pressed. Special keys
805	are those which are intercepted by rxvt-unicode for special handling and	889	are those which are intercepted by rxvt-unicode for special handling and
…		…
824	=item B<borderLess:> I<boolean>	908	=item B<borderLess:> I<boolean>
825		909
826	Set MWM hints to request a borderless window, i.e. if honoured by the	910	Set MWM hints to request a borderless window, i.e. if honoured by the
827	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	911	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
828		912
		913	=item B<skipBuiltinGlyphs:> I<boolean>
		914
		915	Compile I<frills>: Disable the usage of the built-in block graphics/line
		916	drawing characters and just rely on what the specified fonts provide. Use
		917	this if you have a good font and want to use its block graphic glyphs;
		918	option B<-sbg>.
		919
829	=item B<termName:> I<termname>	920	=item B<termName:> I<termname>
830		921
831	Specifies the terminal type name to be set in the B<TERM> environment	922	Specifies the terminal type name to be set in the B<TERM> environment
832	variable; option B<-tn>.	923	variable; option B<-tn>.
833		924
834	=item B<linespace:> I<number>	925	=item B<lineSpace:> I<number>
835		926
836	Specifies number of lines (pixel height) to insert between each row of	927	Specifies number of lines (pixel height) to insert between each row of
837	the display [default 0]; option B<-lsp>.	928	the display [default 0]; option B<-lsp>.
838		929
839	=item B<meta8:> I<boolean>	930	=item B<meta8:> I<boolean>
…		…
888	pressed. If unset it will send the sequence traditionally associated	979	pressed. If unset it will send the sequence traditionally associated
889	with the B<Execute> key.	980	with the B<Execute> key.
890		981
891	=item B<cutchars:> I<string>	982	=item B<cutchars:> I<string>
892		983
893	The characters used as delimiters for double-click word selection. The	984	The characters used as delimiters for double-click word selection
894	built-in default:	985	(whitespace delimiting is added automatically if resource is given).
		986
		987	When the perl selection extension is in use (the default if compiled
		988	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		989	characters will be created (if the resource exists, otherwise, no regex
		990	will be created). In this mode, characters outside ISO-8859-1 can be used.
		991
		992	When the selection extension is not used, only ISO-8859-1 characters can
		993	be used. If not specified, the built-in default is used:
895		994
896	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	995	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
897		996
898	=item B<preeditType:> I<style>	997	=item B<preeditType:> I<style>
899		998
…		…
935	default. (Note that many other terminals, including xterm, have these	1034	default. (Note that many other terminals, including xterm, have these
936	sequences enabled by default, which doesn't make it safer, though).	1035	sequences enabled by default, which doesn't make it safer, though).
937		1036
938	You can enable them by setting this boolean resource or specifying	1037	You can enable them by setting this boolean resource or specifying
939	B<-insecure> as an option. At the moment, this enables display-answer,	1038	B<-insecure> as an option. At the moment, this enables display-answer,
940	locale, findfont, icon label and window title requests as well as dynamic	1039	locale, findfont, icon label and window title requests.
941	menubar dispatch.
942		1040
943	=item B<modifier:> I<modifier>	1041	=item B<modifier:> I<modifier>
944		1042
945	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1043	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
946	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1044	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
950		1048
951	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1049	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
952	character is passed through. It may contain escape values as described	1050	character is passed through. It may contain escape values as described
953	in the entry on B<keysym> following.	1051	in the entry on B<keysym> following.
954		1052
955	=item B<secondaryScreen:> I<bool>	1053	=item B<secondaryScreen:> I<boolean>
956		1054
957	Turn on/off secondary screen (default enabled).	1055	Turn on/off secondary screen (default enabled).
958		1056
959	=item B<secondaryScroll:> I<bool>	1057	=item B<secondaryScroll:> I<boolean>
960		1058
961	Turn on/off secondary screen scroll (default enabled). If the this	1059	Turn on/off secondary screen scroll (default enabled). If this
962	option is enabled, scrolls on the secondary screen will change the	1060	option is enabled, scrolls on the secondary screen will change the
963	scrollback buffer and switching to/from the secondary screen will	1061	scrollback buffer and switching to/from the secondary screen will
964	instead scroll the screen up.	1062	instead scroll the screen up.
965		1063
966	=item B<hold>: I<bool>	1064	=item B<hold>: I<boolean>
967		1065
968	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1066	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
969	will not immediately destroy its window when the program executed within	1067	will not immediately destroy its window when the program executed within
970	it exits. Instead, it will wait till it is being killed or closed by the	1068	it exits. Instead, it will wait till it is being killed or closed by the
971	user.	1069	user.
…		…
990	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1088	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
991	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1089	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
992	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1090	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
993	performed in an exact manner; however, the closest match is assured.	1091	performed in an exact manner; however, the closest match is assured.
994		1092
995	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1093	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
996	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1094	number), see RESOURCES in C<man 7 X> for futher details.
997	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
998	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
999	can start or end with whitespace.
1000
1001	Please note that you need to double the C<\> when using
1002	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1003	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1004	@@RXVT_NAME@@'s own processing).
1005		1095
1006	You can define a range of keysyms in one shot by providing a I<string>	1096	You can define a range of keysyms in one shot by providing a I<string>
1007	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1097	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1008	should be a character not used by the strings.	1098	should be a character not used by the strings.
1009		1099
1010	Its usage can be demonstrated by an example:	1100	Its usage can be demonstrated by an example:
1011		1101
1012	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1102	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1021	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1111	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1022	example the following means "change the current locale to C<zh_CN.GBK>	1112	example the following means "change the current locale to C<zh_CN.GBK>
1023	when Control-Meta-c is being pressed":	1113	when Control-Meta-c is being pressed":
1024		1114
1025	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1115	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1116
		1117	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1118	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1119	manpage. For example, the F<selection> extension (activated via
		1120	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1121
		1122	URxvt.keysym.M-C-c: perl:selection:rot13
1026		1123
1027	Due the the large number of modifier combinations, a defined key mapping	1124	Due the the large number of modifier combinations, a defined key mapping
1028	will match if at I<at least> the specified identifiers are being set, and	1125	will match if at I<at least> the specified identifiers are being set, and
1029	no other key mappings with those and more bits are being defined. That	1126	no other key mappings with those and more bits are being defined. That
1030	means that defining a key map for C<a> will automatically provide	1127	means that defining a key map for C<a> will automatically provide
…		…
1054	info):	1151	info):
1055		1152
1056	URxvt.keysym.M-C-3: command:\033[8;25;80t	1153	URxvt.keysym.M-C-3: command:\033[8;25;80t
1057	URxvt.keysym.M-C-4: command:\033[8;48;110t	1154	URxvt.keysym.M-C-4: command:\033[8;48;110t
1058		1155
		1156	=item B<perl-ext-common>: I<string>
		1157
1059	=item B<perl-ext>: I<string>	1158	=item B<perl-ext>: I<string>
1060		1159
1061	Colon-separated list of perl extension scripts to use in this terminal	1160	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1161	use in this terminal instance; option B<-pe>.
		1162
		1163	Extension names can be prefixed with a C<-> sign to prohibit using
		1164	them. This can be useful to selectively disable some extensions loaded
		1165	by default, or specified via the C<perl-ext-common> resource. For
		1166	example, C<default,-selection> will use all the default extension except
		1167	C<selection>.
		1168
		1169	Extension names can also be followed by an argument in angle brackets
		1170	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1171	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1172	multiple times with different arguments will pass multiple arguments to
		1173	the extension.
		1174
1062	instance. Each extension is looked up in the library directories, loaded	1175	Each extension is looked up in the library directories, loaded if
1063	if necessary, and bound to the current terminal instance; option B<-pe>.	1176	necessary, and bound to the current terminal instance.
		1177
		1178	If both of these resources are the empty string, then the perl
		1179	interpreter will not be initialized. The idea behind two options is that
		1180	B<perl-ext-common> will be used for extensions that should be available to
		1181	all instances, while B<perl-ext> is used for specific instances.
1064		1182
1065	=item B<perl-eval>: I<string>	1183	=item B<perl-eval>: I<string>
1066		1184
1067	Perl code to be evaluated when all extensions have been registered. See the	1185	Perl code to be evaluated when all extensions have been registered. See
1068	rxvtperl(3) manpage.	1186	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1187	will be ignored when running setuid/setgid.
1069		1188
1070	=item B<perl-lib>: I<path>	1189	=item B<perl-lib>: I<path>
1071		1190
1072	Colon-separated list of additional directories that hold extension	1191	Colon-separated list of additional directories that hold extension
1073	scripts. When looking for extensions specified by the C<perl> resource,	1192	scripts. When looking for extensions specified by the C<perl> resource,
1074	@@RXVT_NAME@@ will first look in these directories and then in	1193	@@RXVT_NAME@@ will first look in these directories and then in
1075	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1194	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1195	will be ignored when running setuid/setgid.
1076		1196
1077	See the rxvtperl(3) manpage.	1197	See the @@RXVT_NAME@@perl(3) manpage.
		1198
		1199	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1200
		1201	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1202	details.
		1203
		1204	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1205
		1206	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1207	for details.
		1208
		1209	=item B<searchable-scrollback:> I<keysym>
		1210
		1211	Sets the hotkey that starts the incremental scrollback buffer search
		1212	(default: C<M-s>).
		1213
		1214	=item B<urlLauncher>: I<string>
		1215
		1216	Specifies the program to be started with a URL argument. Used by the
		1217	C<selection-popup> and C<matcher> perl extensions.
		1218
		1219	=item B<transient-for>: I<windowid>
		1220
		1221	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1222
		1223	=item B<override-redirect>: I<boolean>
		1224
		1225	Compile I<frills>: Sets override-redirect for the terminal window, making
		1226	it almost invisible to window managers; option B<-override-redirect>.
		1227
		1228	=item B<iso14755_52:> I<boolean>
		1229
		1230	Turn on/off ISO 14755 5.2 mode (default enabled).
1078		1231
1079	=back	1232	=back
1080		1233
1081	=head1 THE SCROLLBAR	1234	=head1 THE SCROLLBAR
1082		1235
…		…
1101	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1254	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1102	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1255	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1103	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1256	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1104	respectively.	1257	respectively.
1105		1258
1106	=head1 TEXT SELECTION AND INSERTION	1259	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1107		1260
1108	The behaviour of text selection and insertion mechanism is similar to	1261	The behaviour of text selection and insertion/pasting mechanism is similar
1109	I<xterm>(1).	1262	to I<xterm>(1).
1110		1263
1111	=over 4	1264	=over 4
1112		1265
1113	=item B<Selection>:	1266	=item B<Selecting>:
1114		1267
1115	Left click at the beginning of the region, drag to the end of the region	1268	Left click at the beginning of the region, drag to the end of the region
1116	and release; Right click to extend the marked region; Left double-click	1269	and release; Right click to extend the marked region; Left double-click
1117	to select a word; Left triple-click to select the entire logical line	1270	to select a word; Left triple-click to select the entire logical line
1118	(which can span multiple screen lines), unless modified by resource	1271	(which can span multiple screen lines), unless modified by resource
…		…
1122	(Compile: I<frills>) will create a rectangular selection instead of a	1275	(Compile: I<frills>) will create a rectangular selection instead of a
1123	normal one. In this mode, every selected row becomes its own line in the	1276	normal one. In this mode, every selected row becomes its own line in the
1124	selection, and trailing whitespace is visually underlined and removed from	1277	selection, and trailing whitespace is visually underlined and removed from
1125	the selection.	1278	the selection.
1126		1279
1127	=item B<Insertion>:	1280	=item B<Pasting>:
1128		1281
1129	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1282	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1130	an B<@@RXVT_NAME@@> window causes the current text selection to be	1283	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1131	inserted as if it had been typed on the keyboard.	1284	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1285
		1286	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1287	inserted too.
1132		1288
1133	=back	1289	=back
1134		1290
1135	=head1 CHANGING FONTS	1291	=head1 CHANGING FONTS
1136		1292
1137	Changing fonts (or font sizes, respectively) via the keypad is not yet	1293	Changing fonts (or font sizes, respectively) via the keypad is not yet
1138	supported in rxvt-unicode. Bug me if you need this.	1294	supported in rxvt-unicode. Bug me if you need this.
1139		1295
1140	You can, however, switch fonts at runtime using escape sequences (and	1296	You can, however, switch fonts at runtime using escape sequences, e.g.:
1141	therefore using the menubar), e.g.:
1142		1297
1143	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1298	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1299
		1300	You can use keyboard shortcuts, too:
		1301
		1302	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1303	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1144		1304
1145	rxvt-unicode will automatically re-apply these fonts to the output so far.	1305	rxvt-unicode will automatically re-apply these fonts to the output so far.
1146		1306
1147	=head1 ISO 14755 SUPPORT	1307	=head1 ISO 14755 SUPPORT
1148		1308
1149	ISO 14755 is a standard for entering and viewing unicode characters	1309	ISO 14755 is a standard for entering and viewing unicode characters
1150	and character codes using the keyboard. It consists of 4 parts. The	1310	and character codes using the keyboard. It consists of 4 parts. The
1151	first part is available rxvt-unicode has been compiled with	1311	first part is available if rxvt-unicode has been compiled with
1152	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1312	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1153	with C<--enable-iso14755>.	1313	with C<--enable-iso14755>.
1154		1314
1155	=over 4	1315	=over 4
1156		1316
…		…
1176	This mode lets you input characters representing the keycap symbols of	1336	This mode lets you input characters representing the keycap symbols of
1177	your keyboard, if representable in the current locale encoding.	1337	your keyboard, if representable in the current locale encoding.
1178		1338
1179	Start by pressing C<Control> and C<Shift> together, then releasing	1339	Start by pressing C<Control> and C<Shift> together, then releasing
1180	them. The next special key (cursor keys, home etc.) you enter will not	1340	them. The next special key (cursor keys, home etc.) you enter will not
1181	invoke it's usual function but instead will insert the corresponding	1341	invoke its usual function but instead will insert the corresponding
1182	keycap symbol. The symbol will only be entered when the key has been	1342	keycap symbol. The symbol will only be entered when the key has been
1183	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1343	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1184	C<ISO Level 2 Switch>, although your intention might have been to enter a	1344	C<ISO Level 2 Switch>, although your intention might have been to enter a
1185	reverse tab (Shift-Tab).	1345	reverse tab (Shift-Tab).
1186		1346
…		…
1219	=head1 COLORS AND GRAPHICS	1379	=head1 COLORS AND GRAPHICS
1220		1380
1221	In addition to the default foreground and background colours,	1381	In addition to the default foreground and background colours,
1222	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1382	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1223	high-intensity bold/blink versions of the same). Here is a list of the	1383	high-intensity bold/blink versions of the same). Here is a list of the
1224	colours with their B<rgb.txt> names.	1384	colours with their names.
1225		1385
1226	=begin table	1386	=begin table
1227		1387
1228	B<color0> (black) = Black	1388	B<color0> (black) = Black
1229	B<color1> (red) = Red3	1389	B<color1> (red) = Red3
…		…
1249	It is also possible to specify the colour values of B<foreground>,	1409	It is also possible to specify the colour values of B<foreground>,
1250	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1410	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1251	a number 0-15, as a convenient shorthand to reference the colour name of	1411	a number 0-15, as a convenient shorthand to reference the colour name of
1252	color0-color15.	1412	color0-color15.
1253		1413
		1414	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1415	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1416	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1417	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1418
		1419	Together, all those colours implement the 88 colour xterm colours. Only
		1420	the first 16 can be changed using resources currently, the rest can only
		1421	be changed via command sequences ("escape codes").
		1422
1254	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1423	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1255	always swapping the foreground/background colours. This is in contrast to	1424	always swapping the foreground/background colours. This is in contrast to
1256	I<xterm>(1) where the colours are only swapped if they have not otherwise	1425	I<xterm>(1) where the colours are only swapped if they have not otherwise
1257	been specified. For example,	1426	been specified. For example,
1258		1427
…		…
1263	would yield White on Black, while on I<xterm>(1) it would yield Black	1432	would yield White on Black, while on I<xterm>(1) it would yield Black
1264	on White.	1433	on White.
1265		1434
1266	=back	1435	=back
1267		1436
		1437	=head2 ALPHA CHANNEL SUPPORT
		1438
		1439	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1440	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1441	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1442	in addition to the ones provided by X, where the additional A component
		1443	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1444	transparent). You can also prefix any color with C<[percent]>, where
		1445	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1446	the color, where C<0> is completely transparent and C<100> is completelxy
		1447	opaque.
		1448
		1449	You probably need to specify B<"-depth 32">, too, and have the luck that
		1450	your X-server uses ARGB pixel layout, as X is far from just supporting
		1451	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1452
		1453	For example, the following selects an almost completely transparent red
		1454	background, and an almost opaque pink foreground:
		1455
		1456	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1457
		1458	I<Please note that transparency of any kind if completely unsupported by
		1459	the author. Don't bug him with installation questions!>
		1460
1268	=head1 ENVIRONMENT	1461	=head1 ENVIRONMENT
1269		1462
1270	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1463	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1271		1464
1272	=over 4	1465	=over 4
1273		1466
1274	=item B<TERM>	1467	=item B<TERM>
1275		1468
1276	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1469	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1277	resources or on the commandline.	1470	resources or on the command line.
1278		1471
1279	=item B<COLORTERM>	1472	=item B<COLORTERM>
1280		1473
1281	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1474	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1282	compiled with XPM support, and optionally with the added extension	1475	compiled with background image support, and optionally with the added
1283	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1476	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1477	screen.
1284		1478
1285	=item B<COLORFGBG>	1479	=item B<COLORFGBG>
1286		1480
1287	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1481	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1288	the colour code used as default foreground/text colour (or the string	1482	the colour code used as default foreground/text colour (or the string
1289	C<default> to indicate that the default-colour escape sequence is to be	1483	C<default> to indicate that the default-colour escape sequence is to be
1290	used), C<bg> is the colour code used as default background colour (or the	1484	used), C<bg> is the colour code used as default background colour (or the
1291	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1485	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1292	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1486	was compiled with background image support. Libraries like C<ncurses>
1293	(and do) use this information to optimize screen output.	1487	and C<slang> can (and do) use this information to optimize screen output.
1294		1488
1295	=item B<WINDOWID>	1489	=item B<WINDOWID>
1296		1490
1297	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1491	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1298	window, which usually has subwindows for the scrollbar, the terminal	1492	window, which usually has subwindows for the scrollbar, the terminal
…		…
1304	C<--with-terminfo=PATH>.	1498	C<--with-terminfo=PATH>.
1305		1499
1306	=item B<DISPLAY>	1500	=item B<DISPLAY>
1307		1501
1308	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1502	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1309	display in it's child processes.	1503	display in its child processes.
1310		1504
1311	=item B<SHELL>	1505	=item B<SHELL>
1312		1506
1313	The shell to be used for command execution, defaults to C</bin/sh>.	1507	The shell to be used for command execution, defaults to C</bin/sh>.
1314
1315	=item B<RXVTPATH>
1316
1317	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1318	files.
1319
1320	=item B<PATH>
1321
1322	Used in the same way as C<RXVTPATH>.
1323		1508
1324	=item B<RXVT_SOCKET>	1509	=item B<RXVT_SOCKET>
1325		1510
1326	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1511	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1327	@@RXVT_NAME@@d(1).	1512	@@RXVT_NAME@@d(1).
…		…
1365		1550
1366	=item Project Coordinator	1551	=item Project Coordinator
1367		1552
1368	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1553	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1369		1554
1370	L<http://software.schmorp.de/#rxvt-unicode>	1555	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1371		1556
1372	=back	1557	=back
1373		1558
1374	=head1 AUTHORS	1559	=head1 AUTHORS
1375		1560
…		…
1397		1582
1398	Project Coordinator (changes.txt 2.21a to 2.4.5)	1583	Project Coordinator (changes.txt 2.21a to 2.4.5)
1399		1584
1400	=item Geoff Wing L<< <gcw@pobox.com> >>	1585	=item Geoff Wing L<< <gcw@pobox.com> >>
1401		1586
1402	Rewrote screen display and text selection routines. Project Coordinator	1587	Rewrote screen display and text selection routines.
		1588
1403	(changes.txt 2.4.6 - rxvt-unicode)	1589	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1404		1590
1405	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1591	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1406		1592
1407	Forked rxvt-unicode, rewrote most of the display code and internal	1593	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1408	character handling to store text in unicode, improve xterm	1594	extension, random hacks, numerous bugfixes and extensions.
1409	compatibility and apply numerous other bugfixes and extensions.
1410		1595
1411	Project Coordinator (Changes 1.0 -)	1596	Project Coordinator (Changes 1.0 -)
1412		1597
		1598	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1599
		1600	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1601
1413	=back	1602	=back
1414		1603

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.79 by root, Mon Jan 2 20:40:20 2006 UTC vs. Revision 1.140 by sasha, Fri Oct 26 18:27:29 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.79 by root, Mon Jan 2 20:40:20 2006 UTC vs.
Revision 1.140 by sasha, Fri Oct 26 18:27:29 2007 UTC