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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.84 by root, Wed Jan 4 05:35:34 2006 UTC vs. Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.84 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC