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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.136 by root, Mon Aug 13 10:01:18 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>	115	=item B<-ss>\|B<+ss>
		116
		117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
		118
		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>.
114		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@@)!>
		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. resource B<fading>.	130	Fade the text by the given percentage when focus is lost. Small values
		131	fade a little only, 100 completely replaces all colours by the fade
		132	colour; resource B<fading>.
		133
		134	=item B<-fadecolor> I<colour>
		135
		136	Fade to this colour when fading is used (see B<-fade>). The default colour
		137	is opaque black. resource B<fadeColor>.
118		138
119	=item B<-tint> I<colour>	139	=item B<-tint> I<colour>
120		140
121	Tint the transparent background pixmap with the given colour when	141	Tint the transparent background pixmap with the given colour when
122	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	142	transparency is enabled with B<-tr> or B<-ip>. This only works for
		143	non-tiled backgrounds, currently. See also the B<-sh> option that can be
123	option that can be used to brighten or darken the image in addition to	144	used to brighten or darken the image in addition to tinting it.
124	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
		148	I<tintColor>. Example:
125		149
126	=item B<-sh>	150	@@RXVT_NAME@@ -tr -tint blue -sh 40
127		151
		152	=item B<-sh> I<number>
		153
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	154	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129	background image in addition to tinting it (i.e. B<-tint> must be	155	background image in addition to (or instead of) tinting it;
130	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>.
131		175
132	=item B<-bg> I<colour>	176	=item B<-bg> I<colour>
133		177
134	Window background colour; resource B<background>.	178	Window background colour; resource B<background>.
135		179
…		…
137		181
138	Window foreground colour; resource B<foreground>.	182	Window foreground colour; resource B<foreground>.
139		183
140	=item B<-pixmap> I<file[;geom]>	184	=item B<-pixmap> I<file[;geom]>
141		185
142	Compile I<XPM>: Specify XPM file for the background and also optionally	186	Compile I<afterimage>: Specify image file for the background and also
143	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
144	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
145	command-line; resource B<backgroundPixmap>.	189	command-line; for more details see resource B<backgroundPixmap>.
146		190
147	=item B<-cr> I<colour>	191	=item B<-cr> I<colour>
148		192
149	The cursor colour; resource B<cursorColor>.	193	The cursor colour; resource B<cursorColor>.
150		194
…		…
162	resource B<borderColor>.	206	resource B<borderColor>.
163		207
164	=item B<-fn> I<fontlist>	208	=item B<-fn> I<fontlist>
165		209
166	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
167	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
168	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
169	smaller, but not (in general) larger. A (hopefully) reasonable default	213	smaller, but not (in general) larger. A (hopefully) reasonable default
170	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.
171		215
172	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
173	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:>,
174	e.g.:	218	e.g.:
175		219
176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	220	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	221	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
179	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
180	section of @@RXVT_NAME@@(7).	224	section of @@RXVT_NAME@@(7).
181		225
182	=item B<-fb> I<fontlist>	226	=item B<-fb> I<fontlist>
183		227
184	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
185	be printed. See resource B<boldFont> for details.	229	are to be printed. See resource B<boldFont> for details.
186		230
187	=item B<-fi> I<fontlist>	231	=item B<-fi> I<fontlist>
188		232
189	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>
190	be printed. See resource B<italicFont> for details.	234	characters are to be printed. See resource B<italicFont> for details.
191		235
192	=item B<-fbi> I<fontlist>	236	=item B<-fbi> I<fontlist>
193		237
194	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
195	be printed. See resource B<boldItalicFont> for details.	239	italic> >> characters are to be printed. See resource B<boldItalicFont>
		240	for details.
		241
		242	=item B<-is>\|B<+is>
		243
		244	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		245	foreground/background (default). See resource B<intensityStyles> for
		246	details.
196		247
197	=item B<-name> I<name>	248	=item B<-name> I<name>
198		249
199	Specify the application name under which resources are to be obtained,	250	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	251	rather than the default executable file name. Name should not contain
…		…
238		289
239	Put scrollbar on right/left; resource B<scrollBar_right>.	290	Put scrollbar on right/left; resource B<scrollBar_right>.
240		291
241	=item B<-st>\|B<+st>	292	=item B<-st>\|B<+st>
242		293
243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	294	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244	resource B<scrollBar_floating>.	295	resource B<scrollBar_floating>.
245		296
246	=item B<-ptab>\|B<+ptab>	297	=item B<-ptab>\|B<+ptab>
247		298
248	If enabled (default), "Horizontal Tab" characters are being stored as	299	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
279	=item B<-bl>	330	=item B<-bl>
280		331
281	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.
282	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
283	decorations; resource B<borderLess>.	334	decorations; resource B<borderLess>.
		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>.
284		347
285	=item B<-lsp> I<number>	348	=item B<-lsp> I<number>
286		349
287	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
288	the display. Useful to work around font rendering problems; resource	351	the display. Useful to work around font rendering problems; resource
…		…
303	given on the command line. If this option is used, it must be the last	366	given on the command line. If this option is used, it must be the last
304	on the command-line. If there is no B<-e> option then the default is to	367	on the command-line. If there is no B<-e> option then the default is to
305	run the program specified by the B<SHELL> environment variable or,	368	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	369	failing that, I<sh(1)>.
307		370
		371	Please note that you must specify a program with arguments. If you want to
		372	run shell commands, you have to specify the shell, like this:
		373
		374	@@RXVT_NAME@@ -e sh -c "shell commands"
		375
308	=item B<-title> I<text>	376	=item B<-title> I<text>
309		377
310	Window title (B<-T> still respected); the default title is the basename	378	Window title (B<-T> still respected); the default title is the basename
311	of the program specified after the B<-e> option, if any, otherwise the	379	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	380	application name; resource B<title>.
…		…
343	for more info.	411	for more info.
344		412
345	=item B<-tcw>	413	=item B<-tcw>
346		414
347	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
348	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
349	end of the logical line only. resource B<tripleclickwords>.	418	end of the logical line only. resource B<tripleclickwords>.
350		419
351	=item B<-insecure>	420	=item B<-insecure>
352		421
353	Enable "insecure" mode, which currently enables most of the escape	422	Enable "insecure" mode, which currently enables most of the escape
…		…
368	=item B<-ssr>\|B<+ssr>	437	=item B<-ssr>\|B<+ssr>
369		438
370	Turn on/off secondary screen scroll (default enabled); resource	439	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	440	B<secondaryScroll>.
372		441
		442	=item B<-hold>\|B<+hold>
		443
		444	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		445	will not immediately destroy its window when the program executed within
		446	it exits. Instead, it will wait till it is being killed or closed by the
		447	user; resource B<hold>.
		448
373	=item B<-keysym.>I<sym>: I<string>	449	=item B<-keysym.>I<sym> I<string>
374		450
375	Remap a key symbol. See resource B<keysym>.	451	Remap a key symbol. See resource B<keysym>.
376		452
377	=item B<-embed>: I<windowid>	453	=item B<-embed> I<windowid>
378		454
379	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,
380	which enables applications to easily embed a terminal.	456	which enables applications to easily embed a terminal.
381		457
382	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
383	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
384	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
385	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.	461	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
386		462
		463	The window will not be destroyed when @@RXVT_NAME@@ exits.
		464
387	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
388	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
389	can use file descriptors to communicate with the programs within the	467	can use file descriptors to communicate with the programs within the
390	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
391	not.	469	not.
		470
		471	Here is a short Gtk2-perl snippet that illustrates how this option can be
		472	used (a longer example is in F<doc/embed>):
		473
		474	my $rxvt = new Gtk2::Socket;
		475	$rxvt->signal_connect_after (realize => sub {
		476	my $xid = $_[0]->window->get_xid;
		477	system "@@RXVT_NAME@@ -embed $xid &";
		478	});
		479
		480	=item B<-pty-fd> I<file descriptor>
		481
		482	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		483	pair but instead use the given file descriptor as the tty master. This is
		484	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		485	without having to run a program within it.
		486
		487	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		488	entries and will not tinker with pty/tty permissions - you have to do that
		489	yourself if you want that.
		490
		491	As an extremely special case, specifying C<-1> will completely suppress
		492	pty/tty operations.
		493
		494	Here is a example in perl that illustrates how this option can be used (a
		495	longer example is in F<doc/pty-fd>):
		496
		497	use IO::Pty;
		498	use Fcntl;
		499
		500	my $pty = new IO::Pty;
		501	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		502	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		503	close $pty;
		504
		505	# now communicate with rxvt
		506	my $slave = $pty->slave;
		507	while (<$slave>) { print $slave "got <$_>\n" }
		508
		509	=item B<-pe> I<string>
		510
		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.
392		513
393	=back	514	=back
394		515
395	=head1 RESOURCES (available also as long-options)	516	=head1 RESOURCES (available also as long-options)
396		517
397	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	518	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
398	options) compiled into your version.	519	options) compiled into your version.
399		520
400	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
401	Xresource data: using the X libraries (Xrm*-functions) or internal	522	distribution do also load settings from the B<~/.Xresources> file when X
402	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	523	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
403	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	524	with later settings overwriting earlier ones:
404	resources using X11 tools like B<xrdb>. Many distribution do also load
405	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
406	will consult the following files/resources in order, with later settings
407	overwriting earlier ones:
408		525
409	1. system-wide app-defaults file, either locale-dependent OR global	526	1. system-wide app-defaults file, either locale-dependent OR global
410	2. app-defaults file in $XAPPLRESDIR	527	2. app-defaults file in $XAPPLRESDIR
411	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	528	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
412	4. SCREEN_RESOURCES for the current screen	529	4. SCREEN_RESOURCES for the current screen
413	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	530	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
414		531
415	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
416	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
417	set in XAPPLOADDIR/URxvt (compile-time defined: usually
418	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
419	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
420	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	532	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
421	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
422	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
423	easily configured, while the class name B<URxvt> allows resources	535	configured, while the class name B<URxvt> allows resources unique to
424	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	536	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
425	shared between different B<@@RXVT_NAME@@> configurations. If no	537	configurations. If no resources are specified, suitable defaults will
426	resources are specified, suitable defaults will be used. Command-line	538	be used. Command-line arguments can be used to override resource
427	arguments can be used to override resource settings. The following	539	settings. The following resources are supported (you might want to
428	resources are allowed:	540	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		541	extensions not documented here):
429		542
430	=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>.
431		549
432	=item B<geometry:> I<geom>	550	=item B<geometry:> I<geom>
433		551
434	Create the window with the specified X window geometry [default 80x24];	552	Create the window with the specified X window geometry [default 80x24];
435	option B<-geometry>.	553	option B<-geometry>.
…		…
472	Use the specified colour to display underlined characters when the	590	Use the specified colour to display underlined characters when the
473	foreground colour is the default.	591	foreground colour is the default.
474		592
475	=item B<colorRV:> I<colour>	593	=item B<colorRV:> I<colour>
476		594
477	Use the specified colour as the background for reverse video	595	Use the specified colour as the background for reverse video characters
478	characters.	596	when OPTION_HC is disabled (--disable-frills).
479		597
480	=item B<underlineColor:> I<colour>	598	=item B<underlineColor:> I<colour>
481		599
482	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
483	itself. If unset, use the foreground colour.	601	itself. If unset, use the foreground colour.
…		…
499	option B<-rv>. B<False>: regular screen colours [default]; option	617	option B<-rv>. B<False>: regular screen colours [default]; option
500	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	618	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
501		619
502	=item B<jumpScroll:> I<boolean>	620	=item B<jumpScroll:> I<boolean>
503		621
504	B<True>: specify that jump scrolling should be used. When scrolling	622	B<True>: specify that jump scrolling should be used. When receiving lots
505	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
506	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>.
507		641
508	=item B<inheritPixmap:> I<boolean>	642	=item B<inheritPixmap:> I<boolean>
509		643
510	B<True>: make the background inherit the parent windows' pixmap, giving	644	B<True>: make the background inherit the parent windows' pixmap, giving
511	artificial transparency. B<False>: do not inherit the parent windows'	645	artificial transparency. B<False>: do not inherit the parent windows'
512	pixmap.	646	pixmap.
513		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
514	=item B<fading:> I<number>	651	=item B<fading:> I<number>
515		652
516	Fade the text by the given percentage when focus is lost.	653	Fade the text by the given percentage when focus is lost; option B<-fade>.
		654
		655	=item B<fadeColor:> I<colour>
		656
		657	Fade to this colour, when fading is used (see B<fading:>). The default
		658	colour is black; option B<-fadecolor>.
517		659
518	=item B<tintColor:> I<colour>	660	=item B<tintColor:> I<colour>
519		661
520	Tint the transparent background pixmap with the given colour.	662	Tint the transparent background pixmap with the given colour; option
		663	B<-tint>.
521		664
522	=item B<shading:> I<number>	665	=item B<shading:> I<number>
523		666
524	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	667	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
525	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>.
526		678
527	=item B<scrollColor:> I<colour>	679	=item B<scrollColor:> I<colour>
528		680
529	Use the specified colour for the scrollbar [default #B2B2B2].	681	Use the specified colour for the scrollbar [default #B2B2B2].
530		682
531	=item B<troughColor:> I<colour>	683	=item B<troughColor:> I<colour>
532		684
533	Use the specified colour for the scrollbar's trough area [default	685	Use the specified colour for the scrollbar's trough area [default
534	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	686	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
535		687
536	=item B<borderColor:> I<colour>	688	=item B<borderColor:> I<colour>
537		689
538	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
539	and the text.	691	and the text.
540		692
541	=item B<backgroundPixmap:> I<file[;geom]>	693	=item B<backgroundPixmap:> I<file[;geom]>
542		694
543	Use the specified XPM file (note the `.xpm' extension is optional) for	695	Use the specified image file for the background and also optionally
544	the background and also optionally specify its scaling with a geometry	696	specify its scaling with a geometry string B<WxH+X+Y>,
545	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	697	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
546	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	698	and B<"X" / "Y"> locate the image centre (percent).
547	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
548	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
549	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
550	be magnified beyond 10 times its original size. The maximum permitted	702	10 times its original size. The maximum permitted scale is 1000.
551	scale is 1000. [default 0x0+50+50]	703	Special string of B<"auto"> used as a geometry will cause image to be
552		704	automatically scaled to match window size.
553	=item B<menu:> I<file[;tag]>	705	If used in conjunction with B<-tr> option - specified pixmap will be
554		706	blended over transparency image using either alpha-blending, or any
555	Read in the specified menu file (note the `.menu' extension is	707	other blending type, specified with B<-blt "type"> option.
556	optional) and also optionally specify a starting tag to find. See the	708	[default 0x0+50+50]
557	reference documentation for details on the syntax for the menuBar.
558		709
559	=item B<path:> I<path>	710	=item B<path:> I<path>
560		711
561	Specify the colon-delimited search path for finding files (XPM and	712	Specify the colon-delimited search path for finding XPM files.
562	menus), in addition to the paths specified by the B<RXVTPATH> and
563	B<PATH> environment variables.
564		713
565	=item B<font:> I<fontlist>	714	=item B<font:> I<fontlist>
566		715
567	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
568	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
569	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
570	be smaller, but not larger. A reasonable default font list is always	719	smaller, but not (in general) larger. A (hopefully) reasonable default
571	appended to it. option B<-fn>.	720	font list is always appended to it; option B<-fn>.
572		721
573	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
574	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:>.
575		724
576	In addition, each font can be prefixed with additional hints and	725	In addition, each font can be prefixed with additional hints and
…		…
578	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
579	fonts.	728	fonts.
580		729
581	For example, this font resource	730	For example, this font resource
582		731
583	URxvt*font: 9x15bold,\	732	URxvt.font: 9x15bold,\
584	-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,\
585	-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, \
586	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	735	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
587	xft:Code2000:antialias=false	736	xft:Code2000:antialias=false
588		737
…		…
622	not possible, replacement fonts of the desired shape will be tried.	771	not possible, replacement fonts of the desired shape will be tried.
623		772
624	If set, but empty, then this specific style is disabled and the normal	773	If set, but empty, then this specific style is disabled and the normal
625	text font will being used for the given style.	774	text font will being used for the given style.
626		775
		776	=item B<intensityStyles:> I<boolean>
		777
		778	When font styles are not enabled, or this option is enabled (B<True>,
		779	option B<-is>, the default), bold and italic font styles imply high
		780	intensity foreground/background colours. Disabling this option (B<False>,
		781	option B<+is>) disables this behaviour, the high intensity colours are not
		782	reachable.
		783
627	=item B<selectstyle:> I<mode>	784	=item B<selectstyle:> I<mode>
628		785
629	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
630	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
631	xterm style selection.	788	gives xterm style selection. Only effective when the original (non-perl)
		789	selection code is in use.
632		790
633	=item B<scrollstyle:> I<mode>	791	=item B<scrollstyle:> I<mode>
634		792
635	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
636	the author's favourite..	794	the author's favourite.
637		795
638	=item B<title:> I<string>	796	=item B<title:> I<string>
639		797
640	Set window title string, the default title is the command-line	798	Set window title string, the default title is the command-line
641	specified after the B<-e> option, if any, otherwise the application	799	specified after the B<-e> option, if any, otherwise the application
…		…
650	=item B<mapAlert:> I<boolean>	808	=item B<mapAlert:> I<boolean>
651		809
652	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
653	de-iconify (map) on receipt of a bell character [default].	811	de-iconify (map) on receipt of a bell character [default].
654		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
655	=item B<visualBell:> I<boolean>	818	=item B<visualBell:> I<boolean>
656		819
657	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>.
658	B<False>: no visual bell [default]; option B<+vb>.	821	B<False>: no visual bell [default]; option B<+vb>.
659		822
…		…
673		836
674	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	837	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
675	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	838	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
676	B<Shift-Print> to include the scrollback as well.	839	B<Shift-Print> to include the scrollback as well.
677		840
		841	The string will be interpreted as if typed into the shell as-is.
		842
		843	Example:
		844
		845	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		846
		847	This creates a new file in your home directory with the screen contents
		848	every time you hit C<Print>.
		849
678	=item B<scrollBar:> I<boolean>	850	=item B<scrollBar:> I<boolean>
679		851
680	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	852	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
681	disable the scrollbar; option B<+sb>.	853	disable the scrollbar; option B<+sb>.
682		854
…		…
702	B<+si>.	874	B<+si>.
703		875
704	=item B<scrollWithBuffer:> I<boolean>	876	=item B<scrollWithBuffer:> I<boolean>
705		877
706	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
707	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
708	with scrollback buffer when tty recieves new lines; option B<-sw>.	880	with scrollback buffer when tty receives new lines; option B<+sw>.
709		881
710	=item B<scrollTtyKeypress:> I<boolean>	882	=item B<scrollTtyKeypress:> I<boolean>
711		883
712	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
713	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
…		…
732	=item B<borderLess:> I<boolean>	904	=item B<borderLess:> I<boolean>
733		905
734	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
735	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>.
736		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
737	=item B<termName:> I<termname>	916	=item B<termName:> I<termname>
738		917
739	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
740	variable; option B<-tn>.	919	variable; option B<-tn>.
741		920
…		…
778		957
779	Mouse pointer background colour.	958	Mouse pointer background colour.
780		959
781	=item B<pointerBlankDelay:> I<number>	960	=item B<pointerBlankDelay:> I<number>
782		961
783	Specifies number of seconds before blanking the pointer [default 2].	962	Specifies number of seconds before blanking the pointer [default 2]. Use a
		963	large number (e.g. C<987654321>) to effectively disable the timeout.
784		964
785	=item B<backspacekey:> I<string>	965	=item B<backspacekey:> I<string>
786		966
787	The string to send when the backspace key is pressed. If set to B<DEC>	967	The string to send when the backspace key is pressed. If set to B<DEC>
788	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	968	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
795	pressed. If unset it will send the sequence traditionally associated	975	pressed. If unset it will send the sequence traditionally associated
796	with the B<Execute> key.	976	with the B<Execute> key.
797		977
798	=item B<cutchars:> I<string>	978	=item B<cutchars:> I<string>
799		979
800	The characters used as delimiters for double-click word selection. The	980	The characters used as delimiters for double-click word selection
801	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:
802		990
803	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	991	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
804		992
805	=item B<preeditType:> I<style>	993	=item B<preeditType:> I<style>
806		994
…		…
813	=item B<imLocale:> I<name>	1001	=item B<imLocale:> I<name>
814		1002
815	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	1003	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
816	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	1004	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
817	input extension to be able to input japanese characters while staying in	1005	input extension to be able to input japanese characters while staying in
818	another locale. option B<-imlocale>.	1006	another locale; option B<-imlocale>.
819		1007
820	=item B<imFont:> I<fontset>	1008	=item B<imFont:> I<fontset>
821		1009
822	Specify the font-set used for XIM styles C<OverTheSpot> or	1010	Specify the font-set used for XIM styles C<OverTheSpot> or
823	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	1011	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
828		1016
829	=item B<tripleclickwords:> I<boolean>	1017	=item B<tripleclickwords:> I<boolean>
830		1018
831	Change the meaning of triple-click selection with the left mouse	1019	Change the meaning of triple-click selection with the left mouse
832	button. Instead of selecting a full line it will extend the selection to	1020	button. Instead of selecting a full line it will extend the selection to
833	the end of the logical line only. option B<-tcw>.	1021	the end of the logical line only; option B<-tcw>.
834		1022
835	=item B<insecure:> I<boolean>	1023	=item B<insecure:> I<boolean>
836		1024
837	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1025	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
838	echo arbitrary strings like the icon name or the locale. This could be	1026	echo arbitrary strings like the icon name or the locale. This could be
839	abused if somebody gets 8-bit-clean access to your display, whether	1027	abused if somebody gets 8-bit-clean access to your display, whether
840	throuh a mail client displaying mail bodies unfiltered or though	1028	through a mail client displaying mail bodies unfiltered or through
841	write(1). Therefore, these sequences are disabled by default. (Note	1029	write(1) or any other means. Therefore, these sequences are disabled by
842	that other terminals, including xterm, have these sequences	1030	default. (Note that many other terminals, including xterm, have these
843	enabled by default). You can enable them by setting this boolean	1031	sequences enabled by default, which doesn't make it safer, though).
844	resource or specifying B<-insecure> as an option. At the moment, this	1032
845	enabled display-answer, locale, findfont, icon label and window title	1033	You can enable them by setting this boolean resource or specifying
846	requests as well as dynamic menubar dispatch.	1034	B<-insecure> as an option. At the moment, this enables display-answer,
		1035	locale, findfont, icon label and window title requests.
847		1036
848	=item B<modifier:> I<modifier>	1037	=item B<modifier:> I<modifier>
849		1038
850	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>,
851	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
…		…
855		1044
856	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)
857	character is passed through. It may contain escape values as described	1046	character is passed through. It may contain escape values as described
858	in the entry on B<keysym> following.	1047	in the entry on B<keysym> following.
859		1048
860	=item B<secondaryScreen:> I<bool>	1049	=item B<secondaryScreen:> I<boolean>
861		1050
862	Turn on/off secondary screen (default enabled).	1051	Turn on/off secondary screen (default enabled).
863		1052
864	=item B<secondaryScroll:> I<bool>	1053	=item B<secondaryScroll:> I<boolean>
865		1054
866	Turn on/off secondary screen scroll (default enabled). If the this	1055	Turn on/off secondary screen scroll (default enabled). If this
867	option is enabled, scrolls on the secondary screen will change the	1056	option is enabled, scrolls on the secondary screen will change the
868	scrollback buffer and switching to/from the secondary screen will	1057	scrollback buffer and switching to/from the secondary screen will
869	instead scroll the screen up.	1058	instead scroll the screen up.
		1059
		1060	=item B<hold>: I<boolean>
		1061
		1062	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1063	will not immediately destroy its window when the program executed within
		1064	it exits. Instead, it will wait till it is being killed or closed by the
		1065	user.
870		1066
871	=item B<keysym.>I<sym>: I<string>	1067	=item B<keysym.>I<sym>: I<string>
872		1068
873	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1069	Compile I<frills>: Associate I<string> with keysym I<sym>. The
874	intervening resource name B<keysym.> cannot be omitted.	1070	intervening resource name B<keysym.> cannot be omitted.
…		…
892		1088
893	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,
894	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,
895	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1091	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
896	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
897	can start or end with whitespace.	1093	can start or end with whitespace. B<This feature is deprecated and will
		1094	be removed>.
898		1095
899	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
900	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
901	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
902	@@RXVT_NAME@@'s own processing).	1099	processing).
903		1100
904	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>
905	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1102	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
906	should be a character not used by the strings.	1103	should be a character not used by the strings.
907		1104
908	Its usage can be demonstrated by an example:	1105	Its usage can be demonstrated by an example:
909		1106
910	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1107	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
920	example the following means "change the current locale to C<zh_CN.GBK>	1117	example the following means "change the current locale to C<zh_CN.GBK>
921	when Control-Meta-c is being pressed":	1118	when Control-Meta-c is being pressed":
922		1119
923	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1120	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
924		1121
		1122	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1123	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1124	manpage. For example, the F<selection> extension (activated via
		1125	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1126
		1127	URxvt.keysym.M-C-c: perl:selection:rot13
		1128
		1129	Due the the large number of modifier combinations, a defined key mapping
		1130	will match if at I<at least> the specified identifiers are being set, and
		1131	no other key mappings with those and more bits are being defined. That
		1132	means that defining a key map for C<a> will automatically provide
		1133	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1134	mappings themselves.
		1135
		1136	Unfortunately, this will override built-in key mappings. For example
		1137	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1138	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1139	user-defined keymap using the C<builtin:> replacement:
		1140
		1141	URxvt.keysym.Insert: <my insert key sequence>
		1142	URxvt.keysym.S-Insert: builtin:
		1143
		1144	The first line defines a mapping for C<Insert> and I<any> combination
		1145	of modifiers. The second line re-establishes the default mapping for
		1146	C<Shift-Insert>.
		1147
925	The following example will map Control-Meta-1 and Control-Meta-2 to	1148	The following example will map Control-Meta-1 and Control-Meta-2 to
926	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1149	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
927	font-switching at runtime:	1150	font-switching at runtime:
928		1151
929	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1152	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
932	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1155	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
933	info):	1156	info):
934		1157
935	URxvt.keysym.M-C-3: command:\033[8;25;80t	1158	URxvt.keysym.M-C-3: command:\033[8;25;80t
936	URxvt.keysym.M-C-4: command:\033[8;48;110t	1159	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1160
		1161	=item B<perl-ext-common>: I<string>
		1162
		1163	=item B<perl-ext>: I<string>
		1164
		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
		1180	Each extension is looked up in the library directories, loaded if
		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.
		1187
		1188	=item B<perl-eval>: I<string>
		1189
		1190	Perl code to be evaluated when all extensions have been registered. See
		1191	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1192	will be ignored when running setuid/setgid.
		1193
		1194	=item B<perl-lib>: I<path>
		1195
		1196	Colon-separated list of additional directories that hold extension
		1197	scripts. When looking for extensions specified by the C<perl> resource,
		1198	@@RXVT_NAME@@ will first look in these directories and then in
		1199	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1200	will be ignored when running setuid/setgid.
		1201
		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).
937		1236
938	=back	1237	=back
939		1238
940	=head1 THE SCROLLBAR	1239	=head1 THE SCROLLBAR
941		1240
…		…
960	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1259	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
961	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1260	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
962	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),
963	respectively.	1262	respectively.
964		1263
965	=head1 TEXT SELECTION AND INSERTION	1264	=head1 THE SELECTION: SELECTING AND PASTING TEXT
966		1265
967	The behaviour of text selection and insertion mechanism is similar to	1266	The behaviour of text selection and insertion/pasting mechanism is similar
968	I<xterm>(1).	1267	to I<xterm>(1).
969		1268
970	=over 4	1269	=over 4
971		1270
972	=item B<Selection>:	1271	=item B<Selecting>:
973		1272
974	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
975	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
976	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
977	(which can span multiple screen lines), unless modified by resource	1276	(which can span multiple screen lines), unless modified by resource
978	B<tripleclickwords>.	1277	B<tripleclickwords>.
979		1278
980	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1279	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
981	(Compile: I<frills>) will create a rectangular selection instead of a normal	1280	(Compile: I<frills>) will create a rectangular selection instead of a
982	one.	1281	normal one. In this mode, every selected row becomes its own line in the
		1282	selection, and trailing whitespace is visually underlined and removed from
		1283	the selection.
983		1284
984	=item B<Insertion>:	1285	=item B<Pasting>:
985		1286
986	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@@>
987	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
988	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.
989		1293
990	=back	1294	=back
991		1295
992	=head1 CHANGING FONTS	1296	=head1 CHANGING FONTS
993		1297
994	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
995	supported in rxvt-unicode. Bug me if you need this.	1299	supported in rxvt-unicode. Bug me if you need this.
996		1300
997	You can, however, switch fonts at runtime using escape sequences (and	1301	You can, however, switch fonts at runtime using escape sequences, e.g.:
998	therefore using the menubar), e.g.:
999		1302
1000	printf '\e]701;%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
1001		1309
1002	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.
1003		1311
1004	=head1 ISO 14755 SUPPORT	1312	=head1 ISO 14755 SUPPORT
1005		1313
1006	ISO 14755 is a standard for entering and viewing unicode characters	1314	ISO 14755 is a standard for entering and viewing unicode characters
1007	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
1008	first part is available rxvt-unicode has been compiled with	1316	first part is available if rxvt-unicode has been compiled with
1009	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
1010	with C<--enable-iso14755>.	1318	with C<--enable-iso14755>.
1011		1319
1012	=over 4	1320	=over 4
1013		1321
…		…
1033	This mode lets you input characters representing the keycap symbols of	1341	This mode lets you input characters representing the keycap symbols of
1034	your keyboard, if representable in the current locale encoding.	1342	your keyboard, if representable in the current locale encoding.
1035		1343
1036	Start by pressing C<Control> and C<Shift> together, then releasing	1344	Start by pressing C<Control> and C<Shift> together, then releasing
1037	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
1038	invoke it's usual function but instead will insert the corresponding	1346	invoke its usual function but instead will insert the corresponding
1039	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
1040	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
1041	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
1042	reverse tab (Shift-Tab).	1350	reverse tab (Shift-Tab).
1043		1351
…		…
1076	=head1 COLORS AND GRAPHICS	1384	=head1 COLORS AND GRAPHICS
1077		1385
1078	In addition to the default foreground and background colours,	1386	In addition to the default foreground and background colours,
1079	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
1080	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
1081	colours with their B<rgb.txt> names.	1389	colours with their names.
1082		1390
1083	=begin table	1391	=begin table
1084		1392
1085	B<color0> (black) = Black	1393	B<color0> (black) = Black
1086	B<color1> (red) = Red3	1394	B<color1> (red) = Red3
…		…
1106	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>,
1107	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1415	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1108	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
1109	color0-color15.	1417	color0-color15.
1110		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
1111	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1428	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1112	always swapping the foreground/background colours. This is in contrast to	1429	always swapping the foreground/background colours. This is in contrast to
1113	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
1114	been specified. For example,	1431	been specified. For example,
1115		1432
…		…
1120	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
1121	on White.	1438	on White.
1122		1439
1123	=back	1440	=back
1124		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
1125	=head1 ENVIRONMENT	1466	=head1 ENVIRONMENT
1126		1467
1127	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1468	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1128		1469
1129	=over 4	1470	=over 4
1130		1471
1131	=item B<TERM>	1472	=item B<TERM>
1132		1473
1133	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
1134	resources or on the commandline.	1475	resources or on the command line.
1135		1476
1136	=item B<COLORTERM>	1477	=item B<COLORTERM>
1137		1478
1138	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
1139	compiled with XPM support, and optionally with the added extension	1480	compiled with XPM support, and optionally with the added extension
1140	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.
1141		1482
1142	=item B<COLORFGBG>	1483	=item B<COLORFGBG>
1143		1484
…		…
1161	C<--with-terminfo=PATH>.	1502	C<--with-terminfo=PATH>.
1162		1503
1163	=item B<DISPLAY>	1504	=item B<DISPLAY>
1164		1505
1165	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
1166	display in it's child processes.	1507	display in its child processes.
1167		1508
1168	=item B<SHELL>	1509	=item B<SHELL>
1169		1510
1170	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>.
1171
1172	=item B<RXVTPATH>
1173
1174	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1175	files.
1176
1177	=item B<PATH>
1178
1179	Used in the same way as C<RXVTPATH>.
1180		1512
1181	=item B<RXVT_SOCKET>	1513	=item B<RXVT_SOCKET>
1182		1514
1183	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
1184	@@RXVT_NAME@@d(1).	1516	@@RXVT_NAME@@d(1).
1185		1517
1186	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1518	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1187		1519
1188	=item B<HOME>	1520	=item B<HOME>
1189		1521
1190	Used to locate the default directory for the unix domain socket for	1522	Used to locate the default directory for the unix domain socket for
1191	daemon communications and to locate various resource files (such as	1523	daemon communications and to locate various resource files (such as
…		…
1212		1544
1213	=back	1545	=back
1214		1546
1215	=head1 SEE ALSO	1547	=head1 SEE ALSO
1216		1548
1217	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1549	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1218
1219	=head1 BUGS
1220
1221	Check the BUGS file for an up-to-date list.
1222
1223	Cursor change support is not yet implemented.
1224
1225	Click-and-drag doesn't work with X11 mouse report overriding.
1226		1550
1227	=head1 CURRENT PROJECT COORDINATOR	1551	=head1 CURRENT PROJECT COORDINATOR
1228		1552
1229	=over 4	1553	=over 4
1230		1554
1231	=item Project Coordinator	1555	=item Project Coordinator
1232		1556
1233	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1557	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1234		1558
1235	L<http://software.schmorp.de/#rxvt-unicode>	1559	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1236		1560
1237	=back	1561	=back
1238		1562
1239	=head1 AUTHORS	1563	=head1 AUTHORS
1240		1564
…		…
1262		1586
1263	Project Coordinator (changes.txt 2.21a to 2.4.5)	1587	Project Coordinator (changes.txt 2.21a to 2.4.5)
1264		1588
1265	=item Geoff Wing L<< <gcw@pobox.com> >>	1589	=item Geoff Wing L<< <gcw@pobox.com> >>
1266		1590
1267	Rewrote screen display and text selection routines. Project Coordinator	1591	Rewrote screen display and text selection routines.
		1592
1268	(changes.txt 2.4.6 - rxvt-unicode)	1593	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1269		1594
1270	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1595	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1271		1596
1272	Forked rxvt-unicode, rewrote most of the display code and internal	1597	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1273	character handling to store text in unicode, improve xterm	1598	extension, random hacks, numerous bugfixes and extensions.
1274	compatibility and apply numerous other bugfixes and extensions.
1275		1599
1276	Project Coordinator (Changes 1.0 -)	1600	Project Coordinator (Changes 1.0 -)
1277		1601
		1602	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1603
		1604	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1605
1278	=back	1606	=back
1279		1607

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs. Revision 1.136 by root, Mon Aug 13 10:01:18 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.136 by root, Mon Aug 13 10:01:18 2007 UTC