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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.81 by root, Mon Jan 2 21:41:51 2006 UTC vs. Revision 1.137 by root, Sat Sep 1 09:38:50 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.81 by root, Mon Jan 2 21:41:51 2006 UTC vs.
Revision 1.137 by root, Sat Sep 1 09:38:50 2007 UTC