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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.77 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.77 by root, Mon Jan 2 19:36:07 2006 UTC vs. Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.77 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC