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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.74 by root, Thu Dec 22 16:44:10 2005 UTC vs.
Revision 1.144 by sasha, Thu Nov 15 18:40:10 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. Also
		151	pure black and pure white colors essentially mean no tinting; resource
132	I<tintColor>. Example:	152	I<tintColor>. Example:
133		153
134	@@RXVT_NAME@@ -tr -tint blue -sh 40	154	@@RXVT_NAME@@ -tr -tint blue -sh 40
135		155
136	=item B<-sh>	156	=item B<-sh> I<number>
137		157
138	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	158	Darken (0 .. 100) or lighten (100 .. 200) the transparent
139	background image in addition to tinting it (i.e. B<-tint> must be	159	background image in addition to (or instead of) tinting it;
140	specified, too, e.g. C<-tint white>).	160	resource I<shading>.
		161
		162	=item B<-blt> I<string>
		163
		164	Specify background blending type. If background pixmap is specified
		165	at the same time as transparency - such pixmap will be blended over
		166	transparency image, using method specified. Supported values are :
		167	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		168	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		169	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		170	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		171
		172	=item B<-blr> I<HxV>
		173
		174	Apply Gaussian Blur with the specified radii to the transparent
		175	background image. If single number is specified - both vertical and
		176	horizontal radii are considered to be the same. Setting one of the
		177	radii to 1 and another to a large number creates interesting effects
		178	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		179	resource I<blurRadius>.
141		180
142	=item B<-bg> I<colour>	181	=item B<-bg> I<colour>
143		182
144	Window background colour; resource B<background>.	183	Window background colour; resource B<background>.
145		184
146	=item B<-fg> I<colour>	185	=item B<-fg> I<colour>
147		186
148	Window foreground colour; resource B<foreground>.	187	Window foreground colour; resource B<foreground>.
149		188
150	=item B<-pixmap> I<file[;geom]>	189	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151		190
152	Compile I<XPM>: Specify XPM file for the background and also optionally	191	Compile I<afterimage>: Specify image file for the background and also
153	specify its scaling with a geometry string. Note you may need to	192	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	193	add quotes to avoid special shell interpretation of the C<;> in the
155	command-line; resource B<backgroundPixmap>.	194	command-line; for more details see resource B<backgroundPixmap>.
156		195
157	=item B<-cr> I<colour>	196	=item B<-cr> I<colour>
158		197
159	The cursor colour; resource B<cursorColor>.	198	The cursor colour; resource B<cursorColor>.
160		199
…		…
172	resource B<borderColor>.	211	resource B<borderColor>.
173		212
174	=item B<-fn> I<fontlist>	213	=item B<-fn> I<fontlist>
175		214
176	Select the fonts to be used. This is a comma separated list of font names	215	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	216	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	217	first font defines the cell size for characters; other fonts might be
179	smaller, but not (in general) larger. A (hopefully) reasonable default	218	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.	219	font list is always appended to it. See resource B<font> for more details.
181		220
182	In short, to specify an X11 core font, just specify it's name or prefix it	221	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:>,	222	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184	e.g.:	223	e.g.:
185		224
186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	225	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	226	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	228	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190	section of @@RXVT_NAME@@(7).	229	section of @@RXVT_NAME@@(7).
191		230
192	=item B<-fb> I<fontlist>	231	=item B<-fb> I<fontlist>
193		232
194	Compile font-styles: The bold font list to use when bold characters are to	233	Compile I<font-styles>: The bold font list to use when B<bold> characters
195	be printed. See resource B<boldFont> for details.	234	are to be printed. See resource B<boldFont> for details.
196		235
197	=item B<-fi> I<fontlist>	236	=item B<-fi> I<fontlist>
198		237
199	Compile font-styles: The italic font list to use when bold characters are to	238	Compile I<font-styles>: The italic font list to use when I<italic>
200	be printed. See resource B<italicFont> for details.	239	characters are to be printed. See resource B<italicFont> for details.
201		240
202	=item B<-fbi> I<fontlist>	241	=item B<-fbi> I<fontlist>
203		242
204	Compile font-styles: The bold italic font list to use when bold characters are to	243	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205	be printed. See resource B<boldItalicFont> for details.	244	italic> >> characters are to be printed. See resource B<boldItalicFont>
		245	for details.
		246
		247	=item B<-is>\|B<+is>
		248
		249	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		250	foreground/background (default). See resource B<intensityStyles> for
		251	details.
206		252
207	=item B<-name> I<name>	253	=item B<-name> I<name>
208		254
209	Specify the application name under which resources are to be obtained,	255	Specify the application name under which resources are to be obtained,
210	rather than the default executable file name. Name should not contain	256	rather than the default executable file name. Name should not contain
…		…
290		336
291	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	337	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
292	if honoured by the WM, the rxvt-unicode window will not have window	338	if honoured by the WM, the rxvt-unicode window will not have window
293	decorations; resource B<borderLess>.	339	decorations; resource B<borderLess>.
294		340
		341	=item B<-override-redirect>
		342
		343	Compile I<frills>: Sets override-redirect on the window; resource
		344	B<override-redirect>.
		345
		346	=item B<-sbg>
		347
		348	Compile I<frills>: Disable the usage of the built-in block graphics/line
		349	drawing characters and just rely on what the specified fonts provide. Use
		350	this if you have a good font and want to use its block graphic glyphs;
		351	resource B<skipBuiltinGlyphs>.
		352
295	=item B<-lsp> I<number>	353	=item B<-lsp> I<number>
296		354
297	Compile I<frills>: Lines (pixel height) to insert between each row of	355	Compile I<frills>: Lines (pixel height) to insert between each row of
298	the display. Useful to work around font rendering problems; resource	356	the display. Useful to work around font rendering problems; resource
299	B<linespace>.	357	B<lineSpace>.
300		358
301	=item B<-tn> I<termname>	359	=item B<-tn> I<termname>
302		360
303	This option specifies the name of the terminal type to be set in the	361	This option specifies the name of the terminal type to be set in the
304	B<TERM> environment variable. This terminal type must exist in the	362	B<TERM> environment variable. This terminal type must exist in the
…		…
358	for more info.	416	for more info.
359		417
360	=item B<-tcw>	418	=item B<-tcw>
361		419
362	Change the meaning of triple-click selection with the left mouse	420	Change the meaning of triple-click selection with the left mouse
		421	button. Only effective when the original (non-perl) selection code is
363	button. Instead of selecting a full line it will extend the selection the	422	in-use. Instead of selecting a full line it will extend the selection the
364	end of the logical line only. resource B<tripleclickwords>.	423	end of the logical line only. resource B<tripleclickwords>.
365		424
366	=item B<-insecure>	425	=item B<-insecure>
367		426
368	Enable "insecure" mode, which currently enables most of the escape	427	Enable "insecure" mode, which currently enables most of the escape
…		…
396		455
397	Remap a key symbol. See resource B<keysym>.	456	Remap a key symbol. See resource B<keysym>.
398		457
399	=item B<-embed> I<windowid>	458	=item B<-embed> I<windowid>
400		459
401	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	460	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
402	which enables applications to easily embed a terminal.	461	which enables applications to easily embed a terminal.
403		462
404	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	463	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
405	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	464	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
406	quite a bit, so don't expect it to keep some specific state. It's best to	465	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
409	The window will not be destroyed when @@RXVT_NAME@@ exits.	468	The window will not be destroyed when @@RXVT_NAME@@ exits.
410		469
411	It might be useful to know that @@RXVT_NAME@@ will not close file	470	It might be useful to know that @@RXVT_NAME@@ will not close file
412	descriptors passed to it (except for stdin/out/err, of course), so you	471	descriptors passed to it (except for stdin/out/err, of course), so you
413	can use file descriptors to communicate with the programs within the	472	can use file descriptors to communicate with the programs within the
414	terminal. This works regardless of wether the C<-embed> option was used or	473	terminal. This works regardless of whether the C<-embed> option was used or
415	not.	474	not.
416		475
417	Here is a short Gtk2-perl snippet that illustrates how this option can be	476	Here is a short Gtk2-perl snippet that illustrates how this option can be
418	used (a longer example is in F<doc/embed>):	477	used (a longer example is in F<doc/embed>):
419		478
…		…
421	$rxvt->signal_connect_after (realize => sub {	480	$rxvt->signal_connect_after (realize => sub {
422	my $xid = $_[0]->window->get_xid;	481	my $xid = $_[0]->window->get_xid;
423	system "@@RXVT_NAME@@ -embed $xid &";	482	system "@@RXVT_NAME@@ -embed $xid &";
424	});	483	});
425		484
426	=item B<-pty-fd> I<fileno>	485	=item B<-pty-fd> I<file descriptor>
427		486
428	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	487	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
429	pair but instead use the given filehandle as the tty master. This is	488	pair but instead use the given file descriptor as the tty master. This is
430	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	489	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
431	without having to run a program within it.	490	without having to run a program within it.
432		491
433	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	492	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
434	entries and will not tinker with pty/tty permissions - you have to do that	493	entries and will not tinker with pty/tty permissions - you have to do that
435	yourself if you want that.	494	yourself if you want that.
		495
		496	As an extremely special case, specifying C<-1> will completely suppress
		497	pty/tty operations.
436		498
437	Here is a example in perl that illustrates how this option can be used (a	499	Here is a example in perl that illustrates how this option can be used (a
438	longer example is in F<doc/pty-fd>):	500	longer example is in F<doc/pty-fd>):
439		501
440	use IO::Pty;	502	use IO::Pty;
…		…
447		509
448	# now communicate with rxvt	510	# now communicate with rxvt
449	my $slave = $pty->slave;	511	my $slave = $pty->slave;
450	while (<$slave>) { print $slave "got <$_>\n" }	512	while (<$slave>) { print $slave "got <$_>\n" }
451		513
		514	=item B<-pe> I<string>
		515
		516	Comma-separated list of perl extension scripts to use (or not to use) in
		517	this terminal instance. See resource B<perl-ext> for details.
		518
452	=back	519	=back
453		520
454	=head1 RESOURCES (available also as long-options)	521	=head1 RESOURCES (available also as long-options)
455		522
456	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	523	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
457	options) compiled into your version.	524	options) compiled into your version.
458		525
459	There are two different methods that @@RXVT_NAME@@ can use to get the	526	You can set and change the resources using X11 tools like B<xrdb>. Many
460	Xresource data: using the X libraries (Xrm*-functions) or internal	527	distribution do also load settings from the B<~/.Xresources> file when X
461	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	528	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
462	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	529	with later settings overwriting earlier ones:
463	resources using X11 tools like B<xrdb>. Many distribution do also load
464	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
465	will consult the following files/resources in order, with later settings
466	overwriting earlier ones:
467		530
468	1. system-wide app-defaults file, either locale-dependent OR global	531	1. system-wide app-defaults file, either locale-dependent OR global
469	2. app-defaults file in $XAPPLRESDIR	532	2. app-defaults file in $XAPPLRESDIR
470	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	533	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
471	4. SCREEN_RESOURCES for the current screen	534	4. SCREEN_RESOURCES for the current screen
472	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	535	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
473		536
474	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
475	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
476	set in XAPPLOADDIR/URxvt (compile-time defined: usually
477	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
478	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
479	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	537	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
480	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	538	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
481	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	539	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
482	easily configured, while the class name B<URxvt> allows resources	540	configured, while the class name B<URxvt> allows resources unique to
483	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	541	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
484	shared between different B<@@RXVT_NAME@@> configurations. If no	542	configurations. If no resources are specified, suitable defaults will
485	resources are specified, suitable defaults will be used. Command-line	543	be used. Command-line arguments can be used to override resource
486	arguments can be used to override resource settings. The following	544	settings. The following resources are supported (you might want to
487	resources are allowed:	545	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		546	extensions not documented here):
488		547
489	=over 4	548	=over 4
		549
		550	=item B<depth:> I<bitdepth>
		551
		552	Compile I<xft>: Attempt to find a visual with the given bit depth;
		553	option B<-depth>.
490		554
491	=item B<geometry:> I<geom>	555	=item B<geometry:> I<geom>
492		556
493	Create the window with the specified X window geometry [default 80x24];	557	Create the window with the specified X window geometry [default 80x24];
494	option B<-geometry>.	558	option B<-geometry>.
…		…
531	Use the specified colour to display underlined characters when the	595	Use the specified colour to display underlined characters when the
532	foreground colour is the default.	596	foreground colour is the default.
533		597
534	=item B<colorRV:> I<colour>	598	=item B<colorRV:> I<colour>
535		599
536	Use the specified colour as the background for reverse video	600	Use the specified colour as the background for reverse video characters
537	characters.	601	when OPTION_HC is disabled (--disable-frills).
538		602
539	=item B<underlineColor:> I<colour>	603	=item B<underlineColor:> I<colour>
540		604
541	If set, use the specified colour as the colour for the underline	605	If set, use the specified colour as the colour for the underline
542	itself. If unset, use the foreground colour.	606	itself. If unset, use the foreground colour.
…		…
558	option B<-rv>. B<False>: regular screen colours [default]; option	622	option B<-rv>. B<False>: regular screen colours [default]; option
559	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	623	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
560		624
561	=item B<jumpScroll:> I<boolean>	625	=item B<jumpScroll:> I<boolean>
562		626
563	B<True>: specify that jump scrolling should be used. When scrolling	627	B<True>: specify that jump scrolling should be used. When receiving lots
564	quickly, fewer screen updates are performed [default]; option B<-j>.	628	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		629	has been read, resulting in fewer updates while still displaying every
		630	received line; option B<-j>.
		631
565	B<False>: specify that smooth scrolling should be used; option B<+j>.	632	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		633	force a screen refresh on each new line it received; option B<+j>.
		634
		635	=item B<skipScroll:> I<boolean>
		636
		637	B<True>: (the default) specify that skip scrolling should be used. When
		638	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
		639	(around 60 times per second), resulting in far fewer updates. This can
		640	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		641	option B<-ss>.
		642
		643	B<False>: specify that everything is to be displayed, even
		644	if the refresh is too fast for the human eye to read anything (or the
		645	monitor to display anything); option B<+ss>.
566		646
567	=item B<inheritPixmap:> I<boolean>	647	=item B<inheritPixmap:> I<boolean>
568		648
569	B<True>: make the background inherit the parent windows' pixmap, giving	649	B<True>: make the background inherit the parent windows' pixmap, giving
570	artificial transparency. B<False>: do not inherit the parent windows'	650	artificial transparency. B<False>: do not inherit the parent windows'
571	pixmap.	651	pixmap.
572		652
		653	I<Please note that transparency of any kind if completely unsupported by
		654	the author. Don't bug him with installation questions!>
		655
573	=item B<fading:> I<number>	656	=item B<fading:> I<number>
574		657
575	Fade the text by the given percentage when focus is lost; option B<-fade>.	658	Fade the text by the given percentage when focus is lost; option B<-fade>.
576		659
577	=item B<fadeColor:> I<colour>	660	=item B<fadeColor:> I<colour>
…		…
584	Tint the transparent background pixmap with the given colour; option	667	Tint the transparent background pixmap with the given colour; option
585	B<-tint>.	668	B<-tint>.
586		669
587	=item B<shading:> I<number>	670	=item B<shading:> I<number>
588		671
589	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	672	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
590	image in addition to tinting it.	673	in addition to tinting it; option B<-sh>.
		674
		675	=item B<blendType:> I<string>
		676
		677	Specify background blending type; option B<-blt>.
		678
		679	=item B<blurRadius:> I<number>
		680
		681	Apply Gaussian Blurr with the specified radius to the transparent
		682	background image; option B<-blr>.
591		683
592	=item B<scrollColor:> I<colour>	684	=item B<scrollColor:> I<colour>
593		685
594	Use the specified colour for the scrollbar [default #B2B2B2].	686	Use the specified colour for the scrollbar [default #B2B2B2].
595		687
…		…
601	=item B<borderColor:> I<colour>	693	=item B<borderColor:> I<colour>
602		694
603	The colour of the border around the text area and between the scrollbar	695	The colour of the border around the text area and between the scrollbar
604	and the text.	696	and the text.
605		697
606	=item B<backgroundPixmap:> I<file[;geom]>	698	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
607		699
608	Use the specified XPM file (note the `.xpm' extension is optional) for	700	Use the specified image file for the background and also optionally
609	the background and also optionally specify its scaling with a geometry	701	specify its scaling with a geometry string B<WxH+X+Y>,
610	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	702	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
611	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	703	and B<"X" / "Y"> locate the image centre (percent).
612	centre (percent). A scale of 0 displays the image with tiling. A scale	704	A scale of 0 displays the image with tiling. A scale of 1 displays the
613	of 1 displays the image without any scaling. A scale of 2 to 9	705	image without any scaling. A scale of 2 to 9 specifies an integer
614	specifies an integer number of images in that direction. No image will	706	number of images in that direction. No image will be magnified beyond
615	be magnified beyond 10 times its original size. The maximum permitted	707	10 times its original size. The maximum permitted scale is 1000.
616	scale is 1000. [default 0x0+50+50]	708	Additional operations can be specified after colon B<:op1:op2...>.
		709	Supported operations are:
		710	B<"tile"> - force background image to be tiled and not scaled. Equivalent to 0x0,
		711	B<"propscale"> - will scale image keeping proportions,
		712	B<"auto"> - will scale image to match window size. Equivalent to 100x100;
		713	B<"hscale"> - will scale image horizontally to the window size;
		714	B<"vscale"> - will scale image vertically to the window size;
		715	B<"scale"> - will scale image to match window size;
		716	B<"root"> - will tile image as if it was a root window background, auto-adjusting
		717	whenever terminal window moves.
617		718
618	=item B<menu:> I<file[;tag]>	719	If used in conjunction with B<-tr> option - specified pixmap will be
619		720	blended over transparency image using either alpha-blending, or any
620	Read in the specified menu file (note the `.menu' extension is	721	other blending type, specified with B<-blt "type"> option.
621	optional) and also optionally specify a starting tag to find. See the	722	[default 0x0+50+50]
622	reference documentation for details on the syntax for the menuBar.
623		723
624	=item B<path:> I<path>	724	=item B<path:> I<path>
625		725
626	Specify the colon-delimited search path for finding files (XPM and	726	Specify the colon-delimited search path for finding background image files.
627	menus), in addition to the paths specified by the B<RXVTPATH> and
628	B<PATH> environment variables.
629		727
630	=item B<font:> I<fontlist>	728	=item B<font:> I<fontlist>
631		729
632	Select the fonts to be used. This is a comma separated list of font	730	Select the fonts to be used. This is a comma separated list of font names
633	names that are used in turn when trying to display Unicode characters.	731	that are checked in order when trying to find glyphs for characters. The
634	The first font defines the cell size for characters; other fonts might	732	first font defines the cell size for characters; other fonts might be
635	be smaller, but not larger. A reasonable default font list is always	733	smaller, but not (in general) larger. A (hopefully) reasonable default
636	appended to it. option B<-fn>.	734	font list is always appended to it; option B<-fn>.
637		735
638	Each font can either be a standard X11 core font (XLFD) name, with	736	Each font can either be a standard X11 core font (XLFD) name, with
639	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	737	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
640		738
641	In addition, each font can be prefixed with additional hints and	739	In addition, each font can be prefixed with additional hints and
…		…
643	hint currently is C<codeset=codeset-name>, and this is only used for Xft	741	hint currently is C<codeset=codeset-name>, and this is only used for Xft
644	fonts.	742	fonts.
645		743
646	For example, this font resource	744	For example, this font resource
647		745
648	URxvt*font: 9x15bold,\	746	URxvt.font: 9x15bold,\
649	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	747	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
650	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	748	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
651	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	749	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
652	xft:Code2000:antialias=false	750	xft:Code2000:antialias=false
653		751
…		…
687	not possible, replacement fonts of the desired shape will be tried.	785	not possible, replacement fonts of the desired shape will be tried.
688		786
689	If set, but empty, then this specific style is disabled and the normal	787	If set, but empty, then this specific style is disabled and the normal
690	text font will being used for the given style.	788	text font will being used for the given style.
691		789
		790	=item B<intensityStyles:> I<boolean>
		791
		792	When font styles are not enabled, or this option is enabled (B<True>,
		793	option B<-is>, the default), bold and italic font styles imply high
		794	intensity foreground/background colours. Disabling this option (B<False>,
		795	option B<+is>) disables this behaviour, the high intensity colours are not
		796	reachable.
		797
692	=item B<selectstyle:> I<mode>	798	=item B<selectstyle:> I<mode>
693		799
694	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	800	Set mouse selection style to B<old> which is 2.20, B<oldword> which
695	xterm style with 2.20 old word selection, or anything else which gives	801	is xterm style with 2.20 old word selection, or anything else which
696	xterm style selection.	802	gives xterm style selection. Only effective when the original (non-perl)
		803	selection code is in use.
697		804
698	=item B<scrollstyle:> I<mode>	805	=item B<scrollstyle:> I<mode>
699		806
700	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	807	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
701	the author's favourite.	808	the author's favourite.
…		…
715	=item B<mapAlert:> I<boolean>	822	=item B<mapAlert:> I<boolean>
716		823
717	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	824	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
718	de-iconify (map) on receipt of a bell character [default].	825	de-iconify (map) on receipt of a bell character [default].
719		826
		827	=item B<urgentOnBell:> I<boolean>
		828
		829	B<True>: set the urgency hint for the wm on receipt of a bell character.
		830	B<False>: do not set the urgency hint [default].
		831
720	=item B<visualBell:> I<boolean>	832	=item B<visualBell:> I<boolean>
721		833
722	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	834	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
723	B<False>: no visual bell [default]; option B<+vb>.	835	B<False>: no visual bell [default]; option B<+vb>.
724		836
…		…
742		854
743	The string will be interpreted as if typed into the shell as-is.	855	The string will be interpreted as if typed into the shell as-is.
744		856
745	Example:	857	Example:
746		858
747	URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	859	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
748		860
749	This creates a new file in your home directory with the screen contents	861	This creates a new file in your home directory with the screen contents
750	everytime you hit C<Print>.	862	every time you hit C<Print>.
751		863
752	=item B<scrollBar:> I<boolean>	864	=item B<scrollBar:> I<boolean>
753		865
754	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	866	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
755	disable the scrollbar; option B<+sb>.	867	disable the scrollbar; option B<+sb>.
…		…
777		889
778	=item B<scrollWithBuffer:> I<boolean>	890	=item B<scrollWithBuffer:> I<boolean>
779		891
780	B<True>: scroll with scrollback buffer when tty receives new lines (and	892	B<True>: scroll with scrollback buffer when tty receives new lines (and
781	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	893	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
782	with scrollback buffer when tty recieves new lines; option B<+sw>.	894	with scrollback buffer when tty receives new lines; option B<+sw>.
783		895
784	=item B<scrollTtyKeypress:> I<boolean>	896	=item B<scrollTtyKeypress:> I<boolean>
785		897
786	B<True>: scroll to bottom when a non-special key is pressed. Special keys	898	B<True>: scroll to bottom when a non-special key is pressed. Special keys
787	are those which are intercepted by rxvt-unicode for special handling and	899	are those which are intercepted by rxvt-unicode for special handling and
…		…
806	=item B<borderLess:> I<boolean>	918	=item B<borderLess:> I<boolean>
807		919
808	Set MWM hints to request a borderless window, i.e. if honoured by the	920	Set MWM hints to request a borderless window, i.e. if honoured by the
809	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	921	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
810		922
		923	=item B<skipBuiltinGlyphs:> I<boolean>
		924
		925	Compile I<frills>: Disable the usage of the built-in block graphics/line
		926	drawing characters and just rely on what the specified fonts provide. Use
		927	this if you have a good font and want to use its block graphic glyphs;
		928	option B<-sbg>.
		929
811	=item B<termName:> I<termname>	930	=item B<termName:> I<termname>
812		931
813	Specifies the terminal type name to be set in the B<TERM> environment	932	Specifies the terminal type name to be set in the B<TERM> environment
814	variable; option B<-tn>.	933	variable; option B<-tn>.
815		934
816	=item B<linespace:> I<number>	935	=item B<lineSpace:> I<number>
817		936
818	Specifies number of lines (pixel height) to insert between each row of	937	Specifies number of lines (pixel height) to insert between each row of
819	the display [default 0]; option B<-lsp>.	938	the display [default 0]; option B<-lsp>.
820		939
821	=item B<meta8:> I<boolean>	940	=item B<meta8:> I<boolean>
…		…
870	pressed. If unset it will send the sequence traditionally associated	989	pressed. If unset it will send the sequence traditionally associated
871	with the B<Execute> key.	990	with the B<Execute> key.
872		991
873	=item B<cutchars:> I<string>	992	=item B<cutchars:> I<string>
874		993
875	The characters used as delimiters for double-click word selection. The	994	The characters used as delimiters for double-click word selection
876	built-in default:	995	(whitespace delimiting is added automatically if resource is given).
		996
		997	When the perl selection extension is in use (the default if compiled
		998	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		999	characters will be created (if the resource exists, otherwise, no regex
		1000	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1001
		1002	When the selection extension is not used, only ISO-8859-1 characters can
		1003	be used. If not specified, the built-in default is used:
877		1004
878	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1005	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
879		1006
880	=item B<preeditType:> I<style>	1007	=item B<preeditType:> I<style>
881		1008
…		…
888	=item B<imLocale:> I<name>	1015	=item B<imLocale:> I<name>
889		1016
890	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	1017	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
891	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	1018	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
892	input extension to be able to input japanese characters while staying in	1019	input extension to be able to input japanese characters while staying in
893	another locale. option B<-imlocale>.	1020	another locale; option B<-imlocale>.
894		1021
895	=item B<imFont:> I<fontset>	1022	=item B<imFont:> I<fontset>
896		1023
897	Specify the font-set used for XIM styles C<OverTheSpot> or	1024	Specify the font-set used for XIM styles C<OverTheSpot> or
898	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	1025	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
903		1030
904	=item B<tripleclickwords:> I<boolean>	1031	=item B<tripleclickwords:> I<boolean>
905		1032
906	Change the meaning of triple-click selection with the left mouse	1033	Change the meaning of triple-click selection with the left mouse
907	button. Instead of selecting a full line it will extend the selection to	1034	button. Instead of selecting a full line it will extend the selection to
908	the end of the logical line only. option B<-tcw>.	1035	the end of the logical line only; option B<-tcw>.
909		1036
910	=item B<insecure:> I<boolean>	1037	=item B<insecure:> I<boolean>
911		1038
912	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1039	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
913	echo arbitrary strings like the icon name or the locale. This could be	1040	echo arbitrary strings like the icon name or the locale. This could be
…		…
917	default. (Note that many other terminals, including xterm, have these	1044	default. (Note that many other terminals, including xterm, have these
918	sequences enabled by default, which doesn't make it safer, though).	1045	sequences enabled by default, which doesn't make it safer, though).
919		1046
920	You can enable them by setting this boolean resource or specifying	1047	You can enable them by setting this boolean resource or specifying
921	B<-insecure> as an option. At the moment, this enables display-answer,	1048	B<-insecure> as an option. At the moment, this enables display-answer,
922	locale, findfont, icon label and window title requests as well as dynamic	1049	locale, findfont, icon label and window title requests.
923	menubar dispatch.
924		1050
925	=item B<modifier:> I<modifier>	1051	=item B<modifier:> I<modifier>
926		1052
927	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1053	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
928	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1054	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
932		1058
933	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1059	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
934	character is passed through. It may contain escape values as described	1060	character is passed through. It may contain escape values as described
935	in the entry on B<keysym> following.	1061	in the entry on B<keysym> following.
936		1062
937	=item B<secondaryScreen:> I<bool>	1063	=item B<secondaryScreen:> I<boolean>
938		1064
939	Turn on/off secondary screen (default enabled).	1065	Turn on/off secondary screen (default enabled).
940		1066
941	=item B<secondaryScroll:> I<bool>	1067	=item B<secondaryScroll:> I<boolean>
942		1068
943	Turn on/off secondary screen scroll (default enabled). If the this	1069	Turn on/off secondary screen scroll (default enabled). If this
944	option is enabled, scrolls on the secondary screen will change the	1070	option is enabled, scrolls on the secondary screen will change the
945	scrollback buffer and switching to/from the secondary screen will	1071	scrollback buffer and switching to/from the secondary screen will
946	instead scroll the screen up.	1072	instead scroll the screen up.
947		1073
948	=item B<hold>: I<bool>	1074	=item B<hold>: I<boolean>
949		1075
950	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1076	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
951	will not immediately destroy its window when the program executed within	1077	will not immediately destroy its window when the program executed within
952	it exits. Instead, it will wait till it is being killed or closed by the	1078	it exits. Instead, it will wait till it is being killed or closed by the
953	user.	1079	user.
…		…
972	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1098	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
973	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1099	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
974	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1100	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
975	performed in an exact manner; however, the closest match is assured.	1101	performed in an exact manner; however, the closest match is assured.
976		1102
977	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1103	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
978	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1104	number), see RESOURCES in C<man 7 X> for futher details.
979	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
980	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
981	can start or end with whitespace.
982
983	Please note that you need to double the C<\> when using
984	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
985	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
986	@@RXVT_NAME@@'s own processing).
987		1105
988	You can define a range of keysyms in one shot by providing a I<string>	1106	You can define a range of keysyms in one shot by providing a I<string>
989	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1107	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
990	should be a character not used by the strings.	1108	should be a character not used by the strings.
991		1109
992	Its usage can be demonstrated by an example:	1110	Its usage can be demonstrated by an example:
993		1111
994	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1112	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
1003	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1121	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1004	example the following means "change the current locale to C<zh_CN.GBK>	1122	example the following means "change the current locale to C<zh_CN.GBK>
1005	when Control-Meta-c is being pressed":	1123	when Control-Meta-c is being pressed":
1006		1124
1007	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1125	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1126
		1127	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1128	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1129	manpage. For example, the F<selection> extension (activated via
		1130	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1131
		1132	URxvt.keysym.M-C-c: perl:selection:rot13
1008		1133
1009	Due the the large number of modifier combinations, a defined key mapping	1134	Due the the large number of modifier combinations, a defined key mapping
1010	will match if at I<at least> the specified identifiers are being set, and	1135	will match if at I<at least> the specified identifiers are being set, and
1011	no other key mappings with those and more bits are being defined. That	1136	no other key mappings with those and more bits are being defined. That
1012	means that defining a key map for C<a> will automatically provide	1137	means that defining a key map for C<a> will automatically provide
…		…
1036	info):	1161	info):
1037		1162
1038	URxvt.keysym.M-C-3: command:\033[8;25;80t	1163	URxvt.keysym.M-C-3: command:\033[8;25;80t
1039	URxvt.keysym.M-C-4: command:\033[8;48;110t	1164	URxvt.keysym.M-C-4: command:\033[8;48;110t
1040		1165
		1166	=item B<perl-ext-common>: I<string>
		1167
		1168	=item B<perl-ext>: I<string>
		1169
		1170	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1171	use in this terminal instance; option B<-pe>.
		1172
		1173	Extension names can be prefixed with a C<-> sign to prohibit using
		1174	them. This can be useful to selectively disable some extensions loaded
		1175	by default, or specified via the C<perl-ext-common> resource. For
		1176	example, C<default,-selection> will use all the default extension except
		1177	C<selection>.
		1178
		1179	Extension names can also be followed by an argument in angle brackets
		1180	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1181	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1182	multiple times with different arguments will pass multiple arguments to
		1183	the extension.
		1184
		1185	Each extension is looked up in the library directories, loaded if
		1186	necessary, and bound to the current terminal instance.
		1187
		1188	If both of these resources are the empty string, then the perl
		1189	interpreter will not be initialized. The idea behind two options is that
		1190	B<perl-ext-common> will be used for extensions that should be available to
		1191	all instances, while B<perl-ext> is used for specific instances.
		1192
		1193	=item B<perl-eval>: I<string>
		1194
		1195	Perl code to be evaluated when all extensions have been registered. See
		1196	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1197	will be ignored when running setuid/setgid.
		1198
		1199	=item B<perl-lib>: I<path>
		1200
		1201	Colon-separated list of additional directories that hold extension
		1202	scripts. When looking for extensions specified by the C<perl> resource,
		1203	@@RXVT_NAME@@ will first look in these directories and then in
		1204	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1205	will be ignored when running setuid/setgid.
		1206
		1207	See the @@RXVT_NAME@@perl(3) manpage.
		1208
		1209	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1210
		1211	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1212	details.
		1213
		1214	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1215
		1216	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1217	for details.
		1218
		1219	=item B<searchable-scrollback:> I<keysym>
		1220
		1221	Sets the hotkey that starts the incremental scrollback buffer search
		1222	(default: C<M-s>).
		1223
		1224	=item B<urlLauncher>: I<string>
		1225
		1226	Specifies the program to be started with a URL argument. Used by the
		1227	C<selection-popup> and C<matcher> perl extensions.
		1228
		1229	=item B<transient-for>: I<windowid>
		1230
		1231	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1232
		1233	=item B<override-redirect>: I<boolean>
		1234
		1235	Compile I<frills>: Sets override-redirect for the terminal window, making
		1236	it almost invisible to window managers; option B<-override-redirect>.
		1237
		1238	=item B<iso14755_52:> I<boolean>
		1239
		1240	Turn on/off ISO 14755 5.2 mode (default enabled).
		1241
1041	=back	1242	=back
1042		1243
1043	=head1 THE SCROLLBAR	1244	=head1 THE SCROLLBAR
1044		1245
1045	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1246	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1063	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1264	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1064	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1265	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1065	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1266	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1066	respectively.	1267	respectively.
1067		1268
1068	=head1 TEXT SELECTION AND INSERTION	1269	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1069		1270
1070	The behaviour of text selection and insertion mechanism is similar to	1271	The behaviour of text selection and insertion/pasting mechanism is similar
1071	I<xterm>(1).	1272	to I<xterm>(1).
1072		1273
1073	=over 4	1274	=over 4
1074		1275
1075	=item B<Selection>:	1276	=item B<Selecting>:
1076		1277
1077	Left click at the beginning of the region, drag to the end of the region	1278	Left click at the beginning of the region, drag to the end of the region
1078	and release; Right click to extend the marked region; Left double-click	1279	and release; Right click to extend the marked region; Left double-click
1079	to select a word; Left triple-click to select the entire logical line	1280	to select a word; Left triple-click to select the entire logical line
1080	(which can span multiple screen lines), unless modified by resource	1281	(which can span multiple screen lines), unless modified by resource
1081	B<tripleclickwords>.	1282	B<tripleclickwords>.
1082		1283
1083	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1284	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1084	(Compile: I<frills>) will create a rectangular selection instead of a normal	1285	(Compile: I<frills>) will create a rectangular selection instead of a
1085	one.	1286	normal one. In this mode, every selected row becomes its own line in the
		1287	selection, and trailing whitespace is visually underlined and removed from
		1288	the selection.
1086		1289
1087	=item B<Insertion>:	1290	=item B<Pasting>:
1088		1291
1089	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1292	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1090	an B<@@RXVT_NAME@@> window causes the current text selection to be	1293	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1091	inserted as if it had been typed on the keyboard.	1294	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1295
		1296	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1297	inserted too.
1092		1298
1093	=back	1299	=back
1094		1300
1095	=head1 CHANGING FONTS	1301	=head1 CHANGING FONTS
1096		1302
1097	Changing fonts (or font sizes, respectively) via the keypad is not yet	1303	Changing fonts (or font sizes, respectively) via the keypad is not yet
1098	supported in rxvt-unicode. Bug me if you need this.	1304	supported in rxvt-unicode. Bug me if you need this.
1099		1305
1100	You can, however, switch fonts at runtime using escape sequences (and	1306	You can, however, switch fonts at runtime using escape sequences, e.g.:
1101	therefore using the menubar), e.g.:
1102		1307
1103	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"	1308	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1309
		1310	You can use keyboard shortcuts, too:
		1311
		1312	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1313	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1104		1314
1105	rxvt-unicode will automatically re-apply these fonts to the output so far.	1315	rxvt-unicode will automatically re-apply these fonts to the output so far.
1106		1316
1107	=head1 ISO 14755 SUPPORT	1317	=head1 ISO 14755 SUPPORT
1108		1318
1109	ISO 14755 is a standard for entering and viewing unicode characters	1319	ISO 14755 is a standard for entering and viewing unicode characters
1110	and character codes using the keyboard. It consists of 4 parts. The	1320	and character codes using the keyboard. It consists of 4 parts. The
1111	first part is available rxvt-unicode has been compiled with	1321	first part is available if rxvt-unicode has been compiled with
1112	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1322	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1113	with C<--enable-iso14755>.	1323	with C<--enable-iso14755>.
1114		1324
1115	=over 4	1325	=over 4
1116		1326
…		…
1136	This mode lets you input characters representing the keycap symbols of	1346	This mode lets you input characters representing the keycap symbols of
1137	your keyboard, if representable in the current locale encoding.	1347	your keyboard, if representable in the current locale encoding.
1138		1348
1139	Start by pressing C<Control> and C<Shift> together, then releasing	1349	Start by pressing C<Control> and C<Shift> together, then releasing
1140	them. The next special key (cursor keys, home etc.) you enter will not	1350	them. The next special key (cursor keys, home etc.) you enter will not
1141	invoke it's usual function but instead will insert the corresponding	1351	invoke its usual function but instead will insert the corresponding
1142	keycap symbol. The symbol will only be entered when the key has been	1352	keycap symbol. The symbol will only be entered when the key has been
1143	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1353	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1144	C<ISO Level 2 Switch>, although your intention might have been to enter a	1354	C<ISO Level 2 Switch>, although your intention might have been to enter a
1145	reverse tab (Shift-Tab).	1355	reverse tab (Shift-Tab).
1146		1356
…		…
1179	=head1 COLORS AND GRAPHICS	1389	=head1 COLORS AND GRAPHICS
1180		1390
1181	In addition to the default foreground and background colours,	1391	In addition to the default foreground and background colours,
1182	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1392	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1183	high-intensity bold/blink versions of the same). Here is a list of the	1393	high-intensity bold/blink versions of the same). Here is a list of the
1184	colours with their B<rgb.txt> names.	1394	colours with their names.
1185		1395
1186	=begin table	1396	=begin table
1187		1397
1188	B<color0> (black) = Black	1398	B<color0> (black) = Black
1189	B<color1> (red) = Red3	1399	B<color1> (red) = Red3
…		…
1209	It is also possible to specify the colour values of B<foreground>,	1419	It is also possible to specify the colour values of B<foreground>,
1210	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1420	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1211	a number 0-15, as a convenient shorthand to reference the colour name of	1421	a number 0-15, as a convenient shorthand to reference the colour name of
1212	color0-color15.	1422	color0-color15.
1213		1423
		1424	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1425	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1426	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1427	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1428
		1429	Together, all those colours implement the 88 colour xterm colours. Only
		1430	the first 16 can be changed using resources currently, the rest can only
		1431	be changed via command sequences ("escape codes").
		1432
1214	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1433	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1215	always swapping the foreground/background colours. This is in contrast to	1434	always swapping the foreground/background colours. This is in contrast to
1216	I<xterm>(1) where the colours are only swapped if they have not otherwise	1435	I<xterm>(1) where the colours are only swapped if they have not otherwise
1217	been specified. For example,	1436	been specified. For example,
1218		1437
…		…
1223	would yield White on Black, while on I<xterm>(1) it would yield Black	1442	would yield White on Black, while on I<xterm>(1) it would yield Black
1224	on White.	1443	on White.
1225		1444
1226	=back	1445	=back
1227		1446
		1447	=head2 ALPHA CHANNEL SUPPORT
		1448
		1449	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1450	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1451	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1452	in addition to the ones provided by X, where the additional A component
		1453	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1454	transparent). You can also prefix any color with C<[percent]>, where
		1455	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1456	the color, where C<0> is completely transparent and C<100> is completelxy
		1457	opaque.
		1458
		1459	You probably need to specify B<"-depth 32">, too, and have the luck that
		1460	your X-server uses ARGB pixel layout, as X is far from just supporting
		1461	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1462
		1463	For example, the following selects an almost completely transparent red
		1464	background, and an almost opaque pink foreground:
		1465
		1466	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1467
		1468	I<Please note that transparency of any kind if completely unsupported by
		1469	the author. Don't bug him with installation questions!>
		1470
1228	=head1 ENVIRONMENT	1471	=head1 ENVIRONMENT
1229		1472
1230	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1473	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1231		1474
1232	=over 4	1475	=over 4
1233		1476
1234	=item B<TERM>	1477	=item B<TERM>
1235		1478
1236	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1479	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1237	resources or on the commandline.	1480	resources or on the command line.
1238		1481
1239	=item B<COLORTERM>	1482	=item B<COLORTERM>
1240		1483
1241	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1484	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1242	compiled with XPM support, and optionally with the added extension	1485	compiled with background image support, and optionally with the added
1243	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1486	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1487	screen.
1244		1488
1245	=item B<COLORFGBG>	1489	=item B<COLORFGBG>
1246		1490
1247	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1491	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1248	the colour code used as default foreground/text colour (or the string	1492	the colour code used as default foreground/text colour (or the string
1249	C<default> to indicate that the default-colour escape sequence is to be	1493	C<default> to indicate that the default-colour escape sequence is to be
1250	used), C<bg> is the colour code used as default background colour (or the	1494	used), C<bg> is the colour code used as default background colour (or the
1251	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1495	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1252	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1496	was compiled with background image support. Libraries like C<ncurses>
1253	(and do) use this information to optimize screen output.	1497	and C<slang> can (and do) use this information to optimize screen output.
1254		1498
1255	=item B<WINDOWID>	1499	=item B<WINDOWID>
1256		1500
1257	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1501	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1258	window, which usually has subwindows for the scrollbar, the terminal	1502	window, which usually has subwindows for the scrollbar, the terminal
…		…
1264	C<--with-terminfo=PATH>.	1508	C<--with-terminfo=PATH>.
1265		1509
1266	=item B<DISPLAY>	1510	=item B<DISPLAY>
1267		1511
1268	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1512	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1269	display in it's child processes.	1513	display in its child processes.
1270		1514
1271	=item B<SHELL>	1515	=item B<SHELL>
1272		1516
1273	The shell to be used for command execution, defaults to C</bin/sh>.	1517	The shell to be used for command execution, defaults to C</bin/sh>.
1274
1275	=item B<RXVTPATH>
1276
1277	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1278	files.
1279
1280	=item B<PATH>
1281
1282	Used in the same way as C<RXVTPATH>.
1283		1518
1284	=item B<RXVT_SOCKET>	1519	=item B<RXVT_SOCKET>
1285		1520
1286	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1521	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1287	@@RXVT_NAME@@d(1).	1522	@@RXVT_NAME@@d(1).
…		…
1325		1560
1326	=item Project Coordinator	1561	=item Project Coordinator
1327		1562
1328	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1563	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1329		1564
1330	L<http://software.schmorp.de/#rxvt-unicode>	1565	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1331		1566
1332	=back	1567	=back
1333		1568
1334	=head1 AUTHORS	1569	=head1 AUTHORS
1335		1570
…		…
1357		1592
1358	Project Coordinator (changes.txt 2.21a to 2.4.5)	1593	Project Coordinator (changes.txt 2.21a to 2.4.5)
1359		1594
1360	=item Geoff Wing L<< <gcw@pobox.com> >>	1595	=item Geoff Wing L<< <gcw@pobox.com> >>
1361		1596
1362	Rewrote screen display and text selection routines. Project Coordinator	1597	Rewrote screen display and text selection routines.
		1598
1363	(changes.txt 2.4.6 - rxvt-unicode)	1599	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1364		1600
1365	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1601	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1366		1602
1367	Forked rxvt-unicode, rewrote most of the display code and internal	1603	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1368	character handling to store text in unicode, improve xterm	1604	extension, random hacks, numerous bugfixes and extensions.
1369	compatibility and apply numerous other bugfixes and extensions.
1370		1605
1371	Project Coordinator (Changes 1.0 -)	1606	Project Coordinator (Changes 1.0 -)
1372		1607
		1608	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1609
		1610	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1611
1373	=back	1612	=back
1374		1613

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.74 by root, Thu Dec 22 16:44:10 2005 UTC vs. Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.74 by root, Thu Dec 22 16:44:10 2005 UTC vs.
Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC