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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.58 by root, Wed Feb 16 21:49:36 2005 UTC vs.
Revision 1.133 by ayin, Sat Jul 28 20:15: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 devenagari. 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
123	option that can be used to brighten or darken the image in addition to	143	non-tiled backgrounds, currently. See also the B<-sh> option that can be
124	tinting it.	144	used to brighten or darken the image in addition to tinting it; resource
		145	I<tintColor>. Example:
125		146
126	=item B<-sh>	147	@@RXVT_NAME@@ -tr -tint blue -sh 40
127		148
		149	=item B<-sh> I<number>
		150
128	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	151	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129	background image in addition to tinting it (i.e. B<-tint> must be	152	background image in addition to (or instead of) tinting it;
130	specified, too, e.g. C<-tint white>).	153	resource I<shading>.
		154
		155	=item B<-blt> I<string>
		156
		157	Specify background blending type. If background pixmap is specified
		158	at the same time as transparency - such pixmap will be blended over
		159	transparency image, using method specified. Supported values are :
		160	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		163	alpha-blending; resource I<blendType>.
		164
		165	=item B<-blr> I<number>
		166
		167	Apply Gaussian Blur with the specified radius to the transparent
		168	background image; resource I<blurRadius>.
131		169
132	=item B<-bg> I<colour>	170	=item B<-bg> I<colour>
133		171
134	Window background colour; resource B<background>.	172	Window background colour; resource B<background>.
135		173
…		…
137		175
138	Window foreground colour; resource B<foreground>.	176	Window foreground colour; resource B<foreground>.
139		177
140	=item B<-pixmap> I<file[;geom]>	178	=item B<-pixmap> I<file[;geom]>
141		179
142	Compile I<XPM>: Specify XPM file for the background and also optionally	180	Compile I<afterimage>: Specify image file for the background and also
143	specify its scaling with a geometry string. Note you may need to	181	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	182	add quotes to avoid special shell interpretation of the C<;> in the
145	command-line; resource B<backgroundPixmap>.	183	command-line; for more details see resource B<backgroundPixmap>.
146		184
147	=item B<-cr> I<colour>	185	=item B<-cr> I<colour>
148		186
149	The cursor colour; resource B<cursorColor>.	187	The cursor colour; resource B<cursorColor>.
150		188
…		…
162	resource B<borderColor>.	200	resource B<borderColor>.
163		201
164	=item B<-fn> I<fontlist>	202	=item B<-fn> I<fontlist>
165		203
166	Select the fonts to be used. This is a comma separated list of font names	204	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	205	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	206	first font defines the cell size for characters; other fonts might be
169	smaller, but not (in general) larger. A (hopefully) reasonable default	207	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.	208	font list is always appended to it. See resource B<font> for more details.
171		209
172	In short, to specify an X11 core font, just specify it's name or prefix it	210	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:>,	211	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174	e.g.:	212	e.g.:
175		213
176	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	214	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	215	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
179	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	217	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180	section of @@RXVT_NAME@@(7).	218	section of @@RXVT_NAME@@(7).
181		219
182	=item B<-fb> I<fontlist>	220	=item B<-fb> I<fontlist>
183		221
184	Compile font-styles: The bold font list to use when bold characters are to	222	Compile I<font-styles>: The bold font list to use when B<bold> characters
185	be printed. See resource B<boldFont> for details.	223	are to be printed. See resource B<boldFont> for details.
186		224
187	=item B<-fi> I<fontlist>	225	=item B<-fi> I<fontlist>
188		226
189	Compile font-styles: The italic font list to use when bold characters are to	227	Compile I<font-styles>: The italic font list to use when I<italic>
190	be printed. See resource B<italicFont> for details.	228	characters are to be printed. See resource B<italicFont> for details.
191		229
192	=item B<-fbi> I<fontlist>	230	=item B<-fbi> I<fontlist>
193		231
194	Compile font-styles: The bold italic font list to use when bold characters are to	232	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195	be printed. See resource B<boldItalicFont> for details.	233	italic> >> characters are to be printed. See resource B<boldItalicFont>
		234	for details.
		235
		236	=item B<-is>\|B<+is>
		237
		238	Compile I<font-styles>: Bold/Italic font styles imply high intensity
		239	foreground/background (default). See resource B<intensityStyles> for
		240	details.
196		241
197	=item B<-name> I<name>	242	=item B<-name> I<name>
198		243
199	Specify the application name under which resources are to be obtained,	244	Specify the application name under which resources are to be obtained,
200	rather than the default executable file name. Name should not contain	245	rather than the default executable file name. Name should not contain
…		…
238		283
239	Put scrollbar on right/left; resource B<scrollBar_right>.	284	Put scrollbar on right/left; resource B<scrollBar_right>.
240		285
241	=item B<-st>\|B<+st>	286	=item B<-st>\|B<+st>
242		287
243	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	288	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244	resource B<scrollBar_floating>.	289	resource B<scrollBar_floating>.
245		290
246	=item B<-ptab>\|B<+ptab>	291	=item B<-ptab>\|B<+ptab>
247		292
248	If enabled (default), "Horizontal Tab" characters are being stored as	293	If enabled (default), "Horizontal Tab" characters are being stored as
…		…
279	=item B<-bl>	324	=item B<-bl>
280		325
281	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	326	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	327	if honoured by the WM, the rxvt-unicode window will not have window
283	decorations; resource B<borderLess>.	328	decorations; resource B<borderLess>.
		329
		330	=item B<-override-redirect>
		331
		332	Compile I<frills>: Sets override-redirect on the window; resource
		333	B<override-redirect>.
		334
		335	=item B<-sbg>
		336
		337	Compile I<frills>: Disable the usage of the built-in block graphics/line
		338	drawing characters and just rely on what the specified fonts provide. Use
		339	this if you have a good font and want to use its block graphic glyphs;
		340	resource B<skipBuiltinGlyphs>.
284		341
285	=item B<-lsp> I<number>	342	=item B<-lsp> I<number>
286		343
287	Compile I<frills>: Lines (pixel height) to insert between each row of	344	Compile I<frills>: Lines (pixel height) to insert between each row of
288	the display. Useful to work around font rendering problems; resource	345	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	360	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	361	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,	362	run the program specified by the B<SHELL> environment variable or,
306	failing that, I<sh(1)>.	363	failing that, I<sh(1)>.
307		364
		365	Please note that you must specify a program with arguments. If you want to
		366	run shell commands, you have to specify the shell, like this:
		367
		368	@@RXVT_NAME@@ -e sh -c "shell commands"
		369
308	=item B<-title> I<text>	370	=item B<-title> I<text>
309		371
310	Window title (B<-T> still respected); the default title is the basename	372	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	373	of the program specified after the B<-e> option, if any, otherwise the
312	application name; resource B<title>.	374	application name; resource B<title>.
…		…
343	for more info.	405	for more info.
344		406
345	=item B<-tcw>	407	=item B<-tcw>
346		408
347	Change the meaning of triple-click selection with the left mouse	409	Change the meaning of triple-click selection with the left mouse
		410	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	411	in-use. Instead of selecting a full line it will extend the selection the
349	end of the logical line only. resource B<tripleclickwords>.	412	end of the logical line only. resource B<tripleclickwords>.
350		413
351	=item B<-insecure>	414	=item B<-insecure>
352		415
353	Enable "insecure" mode, which currently enables most of the escape	416	Enable "insecure" mode, which currently enables most of the escape
…		…
368	=item B<-ssr>\|B<+ssr>	431	=item B<-ssr>\|B<+ssr>
369		432
370	Turn on/off secondary screen scroll (default enabled); resource	433	Turn on/off secondary screen scroll (default enabled); resource
371	B<secondaryScroll>.	434	B<secondaryScroll>.
372		435
		436	=item B<-hold>\|B<+hold>
		437
		438	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		439	will not immediately destroy its window when the program executed within
		440	it exits. Instead, it will wait till it is being killed or closed by the
		441	user; resource B<hold>.
		442
373	=item B<-keysym.>I<sym>: I<string>	443	=item B<-keysym.>I<sym> I<string>
374		444
375	Remap a key symbol. See resource B<keysym>.	445	Remap a key symbol. See resource B<keysym>.
376		446
377	=item B<-embed>: I<windowid>	447	=item B<-embed> I<windowid>
378		448
379	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	449	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380	which enables applications to easily embed a terminal.	450	which enables applications to easily embed a terminal.
381		451
382	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	452	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	453	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	454	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
387	The window will not be destroyed when @@RXVT_NAME@@ exits.	457	The window will not be destroyed when @@RXVT_NAME@@ exits.
388		458
389	It might be useful to know that @@RXVT_NAME@@ will not close file	459	It might be useful to know that @@RXVT_NAME@@ will not close file
390	descriptors passed to it (except for stdin/out/err, of course), so you	460	descriptors passed to it (except for stdin/out/err, of course), so you
391	can use file descriptors to communicate with the programs within the	461	can use file descriptors to communicate with the programs within the
392	terminal. This works regardless of wether the C<-embed> option was used or	462	terminal. This works regardless of whether the C<-embed> option was used or
393	not.	463	not.
		464
		465	Here is a short Gtk2-perl snippet that illustrates how this option can be
		466	used (a longer example is in F<doc/embed>):
		467
		468	my $rxvt = new Gtk2::Socket;
		469	$rxvt->signal_connect_after (realize => sub {
		470	my $xid = $_[0]->window->get_xid;
		471	system "@@RXVT_NAME@@ -embed $xid &";
		472	});
		473
		474	=item B<-pty-fd> I<file descriptor>
		475
		476	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		477	pair but instead use the given file descriptor as the tty master. This is
		478	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		479	without having to run a program within it.
		480
		481	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		482	entries and will not tinker with pty/tty permissions - you have to do that
		483	yourself if you want that.
		484
		485	As an extremely special case, specifying C<-1> will completely suppress
		486	pty/tty operations.
		487
		488	Here is a example in perl that illustrates how this option can be used (a
		489	longer example is in F<doc/pty-fd>):
		490
		491	use IO::Pty;
		492	use Fcntl;
		493
		494	my $pty = new IO::Pty;
		495	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		496	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		497	close $pty;
		498
		499	# now communicate with rxvt
		500	my $slave = $pty->slave;
		501	while (<$slave>) { print $slave "got <$_>\n" }
		502
		503	=item B<-pe> I<string>
		504
		505	Comma-separated list of perl extension scripts to use (or not to use) in
		506	this terminal instance. See resource B<perl-ext> for details.
394		507
395	=back	508	=back
396		509
397	=head1 RESOURCES (available also as long-options)	510	=head1 RESOURCES (available also as long-options)
398		511
399	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	512	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
400	options) compiled into your version.	513	options) compiled into your version.
401		514
402	There are two different methods that @@RXVT_NAME@@ can use to get the	515	You can set and change the resources using X11 tools like B<xrdb>. Many
403	Xresource data: using the X libraries (Xrm*-functions) or internal	516	distribution do also load settings from the B<~/.Xresources> file when X
404	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	517	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
405	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	518	with later settings overwriting earlier ones:
406	resources using X11 tools like B<xrdb>. Many distribution do also load
407	settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
408	will consult the following files/resources in order, with later settings
409	overwriting earlier ones:
410		519
411	1. system-wide app-defaults file, either locale-dependent OR global	520	1. system-wide app-defaults file, either locale-dependent OR global
412	2. app-defaults file in $XAPPLRESDIR	521	2. app-defaults file in $XAPPLRESDIR
413	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	522	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
414	4. SCREEN_RESOURCES for the current screen	523	4. SCREEN_RESOURCES for the current screen
415	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	524	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
416		525
417	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
418	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
419	set in XAPPLOADDIR/URxvt (compile-time defined: usually
420	B</usr/lib/X11/app-defaults/URxvt>) and resources set in
421	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
422	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	526	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
423	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	527	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
424	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	528	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
425	easily configured, while the class name B<URxvt> allows resources	529	configured, while the class name B<URxvt> allows resources unique to
426	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	530	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
427	shared between different B<@@RXVT_NAME@@> configurations. If no	531	configurations. If no resources are specified, suitable defaults will
428	resources are specified, suitable defaults will be used. Command-line	532	be used. Command-line arguments can be used to override resource
429	arguments can be used to override resource settings. The following	533	settings. The following resources are supported (you might want to
430	resources are allowed:	534	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		535	extensions not documented here):
431		536
432	=over 4	537	=over 4
		538
		539	=item B<depth:> I<bitdepth>
		540
		541	Compile I<xft>: Attempt to find a visual with the given bit depth;
		542	option B<-depth>.
433		543
434	=item B<geometry:> I<geom>	544	=item B<geometry:> I<geom>
435		545
436	Create the window with the specified X window geometry [default 80x24];	546	Create the window with the specified X window geometry [default 80x24];
437	option B<-geometry>.	547	option B<-geometry>.
…		…
474	Use the specified colour to display underlined characters when the	584	Use the specified colour to display underlined characters when the
475	foreground colour is the default.	585	foreground colour is the default.
476		586
477	=item B<colorRV:> I<colour>	587	=item B<colorRV:> I<colour>
478		588
479	Use the specified colour as the background for reverse video	589	Use the specified colour as the background for reverse video characters
480	characters.	590	when OPTION_HC is disabled (--disable-frills).
481		591
482	=item B<underlineColor:> I<colour>	592	=item B<underlineColor:> I<colour>
483		593
484	If set, use the specified colour as the colour for the underline	594	If set, use the specified colour as the colour for the underline
485	itself. If unset, use the foreground colour.	595	itself. If unset, use the foreground colour.
…		…
501	option B<-rv>. B<False>: regular screen colours [default]; option	611	option B<-rv>. B<False>: regular screen colours [default]; option
502	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	612	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
503		613
504	=item B<jumpScroll:> I<boolean>	614	=item B<jumpScroll:> I<boolean>
505		615
506	B<True>: specify that jump scrolling should be used. When scrolling	616	B<True>: specify that jump scrolling should be used. When receiving lots
507	quickly, fewer screen updates are performed [default]; option B<-j>.	617	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		618	has been read, resulting in fewer updates while still displaying every
		619	received line; option B<-j>.
		620
508	B<False>: specify that smooth scrolling should be used; option B<+j>.	621	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		622	force a screen refresh on each new line it received; option B<+j>.
		623
		624	=item B<skipScroll:> I<boolean>
		625
		626	B<True>: (the default) specify that skip scrolling should be used. When
		627	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
		628	(around 60 times per second), resulting in far fewer updates. This can
		629	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		630	option B<-ss>.
		631
		632	B<False>: specify that everything is to be displayed, even
		633	if the refresh is too fast for the human eye to read anything (or the
		634	monitor to display anything); option B<+ss>.
509		635
510	=item B<inheritPixmap:> I<boolean>	636	=item B<inheritPixmap:> I<boolean>
511		637
512	B<True>: make the background inherit the parent windows' pixmap, giving	638	B<True>: make the background inherit the parent windows' pixmap, giving
513	artificial transparency. B<False>: do not inherit the parent windows'	639	artificial transparency. B<False>: do not inherit the parent windows'
514	pixmap.	640	pixmap.
515		641
		642	I<Please note that transparency of any kind if completely unsupported by
		643	the author. Don't bug him with installation questions!>
		644
516	=item B<fading:> I<number>	645	=item B<fading:> I<number>
517		646
518	Fade the text by the given percentage when focus is lost.	647	Fade the text by the given percentage when focus is lost; option B<-fade>.
		648
		649	=item B<fadeColor:> I<colour>
		650
		651	Fade to this colour, when fading is used (see B<fading:>). The default
		652	colour is black; option B<-fadecolor>.
519		653
520	=item B<tintColor:> I<colour>	654	=item B<tintColor:> I<colour>
521		655
522	Tint the transparent background pixmap with the given colour.	656	Tint the transparent background pixmap with the given colour; option
		657	B<-tint>.
523		658
524	=item B<shading:> I<number>	659	=item B<shading:> I<number>
525		660
526	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	661	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
527	image in addition to tinting it.	662	in addition to tinting it; option B<-sh>.
		663
		664	=item B<blendType:> I<string>
		665
		666	Specify background blending type; option B<-blt>.
		667
		668	=item B<blurRadius:> I<number>
		669
		670	Apply Gaussian Blurr with the specified radius to the transparent
		671	background image; option B<-blr>.
528		672
529	=item B<scrollColor:> I<colour>	673	=item B<scrollColor:> I<colour>
530		674
531	Use the specified colour for the scrollbar [default #B2B2B2].	675	Use the specified colour for the scrollbar [default #B2B2B2].
532		676
533	=item B<troughColor:> I<colour>	677	=item B<troughColor:> I<colour>
534		678
535	Use the specified colour for the scrollbar's trough area [default	679	Use the specified colour for the scrollbar's trough area [default
536	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	680	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
537		681
538	=item B<borderColor:> I<colour>	682	=item B<borderColor:> I<colour>
539		683
540	The colour of the border around the text area and between the scrollbar	684	The colour of the border around the text area and between the scrollbar
541	and the text.	685	and the text.
542		686
543	=item B<backgroundPixmap:> I<file[;geom]>	687	=item B<backgroundPixmap:> I<file[;geom]>
544		688
545	Use the specified XPM file (note the `.xpm' extension is optional) for	689	Use the specified image file for the background and also optionally
546	the background and also optionally specify its scaling with a geometry	690	specify its scaling with a geometry string B<WxH+X+Y>,
547	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	691	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
548	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	692	and B<"X" / "Y"> locate the image centre (percent).
549	centre (percent). A scale of 0 displays the image with tiling. A scale	693	A scale of 0 displays the image with tiling. A scale of 1 displays the
550	of 1 displays the image without any scaling. A scale of 2 to 9	694	image without any scaling. A scale of 2 to 9 specifies an integer
551	specifies an integer number of images in that direction. No image will	695	number of images in that direction. No image will be magnified beyond
552	be magnified beyond 10 times its original size. The maximum permitted	696	10 times its original size. The maximum permitted scale is 1000.
553	scale is 1000. [default 0x0+50+50]	697	Special string of B<"auto"> used as a geometry will cause image to be
554		698	automatically scaled to match window size.
555	=item B<menu:> I<file[;tag]>	699	If used in conjunction with B<-tr> option - specified pixmap will be
556		700	blended over transparency image using either alpha-blending, or any
557	Read in the specified menu file (note the `.menu' extension is	701	other blending type, specified with B<-blt "type"> option.
558	optional) and also optionally specify a starting tag to find. See the	702	[default 0x0+50+50]
559	reference documentation for details on the syntax for the menuBar.
560		703
561	=item B<path:> I<path>	704	=item B<path:> I<path>
562		705
563	Specify the colon-delimited search path for finding files (XPM and	706	Specify the colon-delimited search path for finding XPM files.
564	menus), in addition to the paths specified by the B<RXVTPATH> and
565	B<PATH> environment variables.
566		707
567	=item B<font:> I<fontlist>	708	=item B<font:> I<fontlist>
568		709
569	Select the fonts to be used. This is a comma separated list of font	710	Select the fonts to be used. This is a comma separated list of font names
570	names that are used in turn when trying to display Unicode characters.	711	that are checked in order when trying to find glyphs for characters. The
571	The first font defines the cell size for characters; other fonts might	712	first font defines the cell size for characters; other fonts might be
572	be smaller, but not larger. A reasonable default font list is always	713	smaller, but not (in general) larger. A (hopefully) reasonable default
573	appended to it. option B<-fn>.	714	font list is always appended to it; option B<-fn>.
574		715
575	Each font can either be a standard X11 core font (XLFD) name, with	716	Each font can either be a standard X11 core font (XLFD) name, with
576	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	717	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
577		718
578	In addition, each font can be prefixed with additional hints and	719	In addition, each font can be prefixed with additional hints and
…		…
580	hint currently is C<codeset=codeset-name>, and this is only used for Xft	721	hint currently is C<codeset=codeset-name>, and this is only used for Xft
581	fonts.	722	fonts.
582		723
583	For example, this font resource	724	For example, this font resource
584		725
585	URxvt*font: 9x15bold,\	726	URxvt.font: 9x15bold,\
586	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	727	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
587	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	728	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
588	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	729	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
589	xft:Code2000:antialias=false	730	xft:Code2000:antialias=false
590		731
…		…
624	not possible, replacement fonts of the desired shape will be tried.	765	not possible, replacement fonts of the desired shape will be tried.
625		766
626	If set, but empty, then this specific style is disabled and the normal	767	If set, but empty, then this specific style is disabled and the normal
627	text font will being used for the given style.	768	text font will being used for the given style.
628		769
		770	=item B<intensityStyles:> I<boolean>
		771
		772	When font styles are not enabled, or this option is enabled (B<True>,
		773	option B<-is>, the default), bold and italic font styles imply high
		774	intensity foreground/background colours. Disabling this option (B<False>,
		775	option B<+is>) disables this behaviour, the high intensity colours are not
		776	reachable.
		777
629	=item B<selectstyle:> I<mode>	778	=item B<selectstyle:> I<mode>
630		779
631	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	780	Set mouse selection style to B<old> which is 2.20, B<oldword> which
632	xterm style with 2.20 old word selection, or anything else which gives	781	is xterm style with 2.20 old word selection, or anything else which
633	xterm style selection.	782	gives xterm style selection. Only effective when the original (non-perl)
		783	selection code is in use.
634		784
635	=item B<scrollstyle:> I<mode>	785	=item B<scrollstyle:> I<mode>
636		786
637	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	787	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
638	the author's favourite..	788	the author's favourite.
639		789
640	=item B<title:> I<string>	790	=item B<title:> I<string>
641		791
642	Set window title string, the default title is the command-line	792	Set window title string, the default title is the command-line
643	specified after the B<-e> option, if any, otherwise the application	793	specified after the B<-e> option, if any, otherwise the application
…		…
652	=item B<mapAlert:> I<boolean>	802	=item B<mapAlert:> I<boolean>
653		803
654	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	804	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
655	de-iconify (map) on receipt of a bell character [default].	805	de-iconify (map) on receipt of a bell character [default].
656		806
		807	=item B<urgentOnBell:> I<boolean>
		808
		809	B<True>: set the urgency hint for the wm on receipt of a bell character.
		810	B<False>: do not set the urgency hint [default].
		811
657	=item B<visualBell:> I<boolean>	812	=item B<visualBell:> I<boolean>
658		813
659	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	814	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
660	B<False>: no visual bell [default]; option B<+vb>.	815	B<False>: no visual bell [default]; option B<+vb>.
661		816
…		…
675		830
676	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	831	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
677	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	832	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
678	B<Shift-Print> to include the scrollback as well.	833	B<Shift-Print> to include the scrollback as well.
679		834
		835	The string will be interpreted as if typed into the shell as-is.
		836
		837	Example:
		838
		839	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		840
		841	This creates a new file in your home directory with the screen contents
		842	every time you hit C<Print>.
		843
680	=item B<scrollBar:> I<boolean>	844	=item B<scrollBar:> I<boolean>
681		845
682	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	846	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
683	disable the scrollbar; option B<+sb>.	847	disable the scrollbar; option B<+sb>.
684		848
…		…
705		869
706	=item B<scrollWithBuffer:> I<boolean>	870	=item B<scrollWithBuffer:> I<boolean>
707		871
708	B<True>: scroll with scrollback buffer when tty receives new lines (and	872	B<True>: scroll with scrollback buffer when tty receives new lines (and
709	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	873	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
710	with scrollback buffer when tty recieves new lines; option B<+sw>.	874	with scrollback buffer when tty receives new lines; option B<+sw>.
711		875
712	=item B<scrollTtyKeypress:> I<boolean>	876	=item B<scrollTtyKeypress:> I<boolean>
713		877
714	B<True>: scroll to bottom when a non-special key is pressed. Special keys	878	B<True>: scroll to bottom when a non-special key is pressed. Special keys
715	are those which are intercepted by rxvt-unicode for special handling and	879	are those which are intercepted by rxvt-unicode for special handling and
…		…
734	=item B<borderLess:> I<boolean>	898	=item B<borderLess:> I<boolean>
735		899
736	Set MWM hints to request a borderless window, i.e. if honoured by the	900	Set MWM hints to request a borderless window, i.e. if honoured by the
737	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	901	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
738		902
		903	=item B<skipBuiltinGlyphs:> I<boolean>
		904
		905	Compile I<frills>: Disable the usage of the built-in block graphics/line
		906	drawing characters and just rely on what the specified fonts provide. Use
		907	this if you have a good font and want to use its block graphic glyphs;
		908	option B<-sbg>.
		909
739	=item B<termName:> I<termname>	910	=item B<termName:> I<termname>
740		911
741	Specifies the terminal type name to be set in the B<TERM> environment	912	Specifies the terminal type name to be set in the B<TERM> environment
742	variable; option B<-tn>.	913	variable; option B<-tn>.
743		914
…		…
780		951
781	Mouse pointer background colour.	952	Mouse pointer background colour.
782		953
783	=item B<pointerBlankDelay:> I<number>	954	=item B<pointerBlankDelay:> I<number>
784		955
785	Specifies number of seconds before blanking the pointer [default 2].	956	Specifies number of seconds before blanking the pointer [default 2]. Use a
		957	large number (e.g. C<987654321>) to effectively disable the timeout.
786		958
787	=item B<backspacekey:> I<string>	959	=item B<backspacekey:> I<string>
788		960
789	The string to send when the backspace key is pressed. If set to B<DEC>	961	The string to send when the backspace key is pressed. If set to B<DEC>
790	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	962	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
797	pressed. If unset it will send the sequence traditionally associated	969	pressed. If unset it will send the sequence traditionally associated
798	with the B<Execute> key.	970	with the B<Execute> key.
799		971
800	=item B<cutchars:> I<string>	972	=item B<cutchars:> I<string>
801		973
802	The characters used as delimiters for double-click word selection. The	974	The characters used as delimiters for double-click word selection
803	built-in default:	975	(whitespace delimiting is added automatically if resource is given).
		976
		977	When the perl selection extension is in use (the default if compiled
		978	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		979	characters will be created (if the resource exists, otherwise, no regex
		980	will be created). In this mode, characters outside ISO-8859-1 can be used.
		981
		982	When the selection extension is not used, only ISO-8859-1 characters can
		983	be used. If not specified, the built-in default is used:
804		984
805	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	985	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>
806		986
807	=item B<preeditType:> I<style>	987	=item B<preeditType:> I<style>
808		988
…		…
815	=item B<imLocale:> I<name>	995	=item B<imLocale:> I<name>
816		996
817	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	997	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
818	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	998	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
819	input extension to be able to input japanese characters while staying in	999	input extension to be able to input japanese characters while staying in
820	another locale. option B<-imlocale>.	1000	another locale; option B<-imlocale>.
821		1001
822	=item B<imFont:> I<fontset>	1002	=item B<imFont:> I<fontset>
823		1003
824	Specify the font-set used for XIM styles C<OverTheSpot> or	1004	Specify the font-set used for XIM styles C<OverTheSpot> or
825	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	1005	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
830		1010
831	=item B<tripleclickwords:> I<boolean>	1011	=item B<tripleclickwords:> I<boolean>
832		1012
833	Change the meaning of triple-click selection with the left mouse	1013	Change the meaning of triple-click selection with the left mouse
834	button. Instead of selecting a full line it will extend the selection to	1014	button. Instead of selecting a full line it will extend the selection to
835	the end of the logical line only. option B<-tcw>.	1015	the end of the logical line only; option B<-tcw>.
836		1016
837	=item B<insecure:> I<boolean>	1017	=item B<insecure:> I<boolean>
838		1018
839	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1019	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
840	echo arbitrary strings like the icon name or the locale. This could be	1020	echo arbitrary strings like the icon name or the locale. This could be
841	abused if somebody gets 8-bit-clean access to your display, whether	1021	abused if somebody gets 8-bit-clean access to your display, whether
842	throuh a mail client displaying mail bodies unfiltered or though	1022	through a mail client displaying mail bodies unfiltered or through
843	write(1). Therefore, these sequences are disabled by default. (Note	1023	write(1) or any other means. Therefore, these sequences are disabled by
844	that other terminals, including xterm, have these sequences	1024	default. (Note that many other terminals, including xterm, have these
845	enabled by default). You can enable them by setting this boolean	1025	sequences enabled by default, which doesn't make it safer, though).
846	resource or specifying B<-insecure> as an option. At the moment, this	1026
847	enabled display-answer, locale, findfont, icon label and window title	1027	You can enable them by setting this boolean resource or specifying
848	requests as well as dynamic menubar dispatch.	1028	B<-insecure> as an option. At the moment, this enables display-answer,
		1029	locale, findfont, icon label and window title requests.
849		1030
850	=item B<modifier:> I<modifier>	1031	=item B<modifier:> I<modifier>
851		1032
852	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1033	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
853	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1034	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
857		1038
858	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1039	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
859	character is passed through. It may contain escape values as described	1040	character is passed through. It may contain escape values as described
860	in the entry on B<keysym> following.	1041	in the entry on B<keysym> following.
861		1042
862	=item B<secondaryScreen:> I<bool>	1043	=item B<secondaryScreen:> I<boolean>
863		1044
864	Turn on/off secondary screen (default enabled).	1045	Turn on/off secondary screen (default enabled).
865		1046
866	=item B<secondaryScroll:> I<bool>	1047	=item B<secondaryScroll:> I<boolean>
867		1048
868	Turn on/off secondary screen scroll (default enabled). If the this	1049	Turn on/off secondary screen scroll (default enabled). If this
869	option is enabled, scrolls on the secondary screen will change the	1050	option is enabled, scrolls on the secondary screen will change the
870	scrollback buffer and switching to/from the secondary screen will	1051	scrollback buffer and switching to/from the secondary screen will
871	instead scroll the screen up.	1052	instead scroll the screen up.
		1053
		1054	=item B<hold>: I<boolean>
		1055
		1056	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1057	will not immediately destroy its window when the program executed within
		1058	it exits. Instead, it will wait till it is being killed or closed by the
		1059	user.
872		1060
873	=item B<keysym.>I<sym>: I<string>	1061	=item B<keysym.>I<sym>: I<string>
874		1062
875	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1063	Compile I<frills>: Associate I<string> with keysym I<sym>. The
876	intervening resource name B<keysym.> cannot be omitted.	1064	intervening resource name B<keysym.> cannot be omitted.
…		…
894		1082
895	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1083	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
896	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1084	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
897	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1085	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
898	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it	1086	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
899	can start or end with whitespace.	1087	can start or end with whitespace. B<This feature is deprecated and will
		1088	be removed>.
900		1089
901	Please note that you need to double the C<\> when using	1090	Please note that you need to double the C<\> in resource files, as
902	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1091	Xlib itself does its own de-escaping (you can use C<\033> instead of
903	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1092	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
904	@@RXVT_NAME@@'s own processing).	1093	processing).
905		1094
906	You can define a range of keysyms in one shot by providing a I<string>	1095	You can define a range of keysyms in one shot by providing a I<string>
907	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1096	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
908	should be a character not used by the strings.	1097	should be a character not used by the strings.
909		1098
910	Its usage can be demonstrated by an example:	1099	Its usage can be demonstrated by an example:
911		1100
912	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1101	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>
…		…
922	example the following means "change the current locale to C<zh_CN.GBK>	1111	example the following means "change the current locale to C<zh_CN.GBK>
923	when Control-Meta-c is being pressed":	1112	when Control-Meta-c is being pressed":
924		1113
925	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1114	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
926		1115
		1116	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1117	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1118	manpage. For example, the F<selection> extension (activated via
		1119	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1120
		1121	URxvt.keysym.M-C-c: perl:selection:rot13
		1122
		1123	Due the the large number of modifier combinations, a defined key mapping
		1124	will match if at I<at least> the specified identifiers are being set, and
		1125	no other key mappings with those and more bits are being defined. That
		1126	means that defining a key map for C<a> will automatically provide
		1127	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1128	mappings themselves.
		1129
		1130	Unfortunately, this will override built-in key mappings. For example
		1131	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1132	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1133	user-defined keymap using the C<builtin:> replacement:
		1134
		1135	URxvt.keysym.Insert: <my insert key sequence>
		1136	URxvt.keysym.S-Insert: builtin:
		1137
		1138	The first line defines a mapping for C<Insert> and I<any> combination
		1139	of modifiers. The second line re-establishes the default mapping for
		1140	C<Shift-Insert>.
		1141
927	The following example will map Control-Meta-1 and Control-Meta-2 to	1142	The following example will map Control-Meta-1 and Control-Meta-2 to
928	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1143	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
929	font-switching at runtime:	1144	font-switching at runtime:
930		1145
931	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1146	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
934	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1149	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
935	info):	1150	info):
936		1151
937	URxvt.keysym.M-C-3: command:\033[8;25;80t	1152	URxvt.keysym.M-C-3: command:\033[8;25;80t
938	URxvt.keysym.M-C-4: command:\033[8;48;110t	1153	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1154
		1155	=item B<perl-ext-common>: I<string>
		1156
		1157	=item B<perl-ext>: I<string>
		1158
		1159	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1160	use in this terminal instance; option B<-pe>.
		1161
		1162	Extension names can be prefixed with a C<-> sign to prohibit using
		1163	them. This can be useful to selectively disable some extensions loaded
		1164	by default, or specified via the C<perl-ext-common> resource. For
		1165	example, C<default,-selection> will use all the default extension except
		1166	C<selection>.
		1167
		1168	Extension names can also be followed by an argument in angle brackets
		1169	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1170	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1171	multiple times with different arguments will pass multiple arguments to
		1172	the extension.
		1173
		1174	Each extension is looked up in the library directories, loaded if
		1175	necessary, and bound to the current terminal instance.
		1176
		1177	If both of these resources are the empty string, then the perl
		1178	interpreter will not be initialized. The idea behind two options is that
		1179	B<perl-ext-common> will be used for extensions that should be available to
		1180	all instances, while B<perl-ext> is used for specific instances.
		1181
		1182	=item B<perl-eval>: I<string>
		1183
		1184	Perl code to be evaluated when all extensions have been registered. See
		1185	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1186	will be ignored when running setuid/setgid.
		1187
		1188	=item B<perl-lib>: I<path>
		1189
		1190	Colon-separated list of additional directories that hold extension
		1191	scripts. When looking for extensions specified by the C<perl> resource,
		1192	@@RXVT_NAME@@ will first look in these directories and then in
		1193	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1194	will be ignored when running setuid/setgid.
		1195
		1196	See the @@RXVT_NAME@@perl(3) manpage.
		1197
		1198	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1199
		1200	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1201	details.
		1202
		1203	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1204
		1205	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1206	for details.
		1207
		1208	=item B<searchable-scrollback:> I<keysym>
		1209
		1210	Sets the hotkey that starts the incremental scrollback buffer search
		1211	(default: C<M-s>).
		1212
		1213	=item B<urlLauncher>: I<string>
		1214
		1215	Specifies the program to be started with a URL argument. Used by the
		1216	C<selection-popup> and C<matcher> perl extensions.
		1217
		1218	=item B<transient-for>: I<windowid>
		1219
		1220	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1221
		1222	=item B<override-redirect>: I<boolean>
		1223
		1224	Compile I<frills>: Sets override-redirect for the terminal window, making
		1225	it almost invisible to window managers; option B<-override-redirect>.
		1226
		1227	=item B<iso14755_52:> I<boolean>
		1228
		1229	Turn on/off ISO 14755 5.2 mode (default enabled).
939		1230
940	=back	1231	=back
941		1232
942	=head1 THE SCROLLBAR	1233	=head1 THE SCROLLBAR
943		1234
…		…
962	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1253	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
963	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1254	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
964	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1255	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
965	respectively.	1256	respectively.
966		1257
967	=head1 TEXT SELECTION AND INSERTION	1258	=head1 THE SELECTION: SELECTING AND PASTING TEXT
968		1259
969	The behaviour of text selection and insertion mechanism is similar to	1260	The behaviour of text selection and insertion/pasting mechanism is similar
970	I<xterm>(1).	1261	to I<xterm>(1).
971		1262
972	=over 4	1263	=over 4
973		1264
974	=item B<Selection>:	1265	=item B<Selecting>:
975		1266
976	Left click at the beginning of the region, drag to the end of the region	1267	Left click at the beginning of the region, drag to the end of the region
977	and release; Right click to extend the marked region; Left double-click	1268	and release; Right click to extend the marked region; Left double-click
978	to select a word; Left triple-click to select the entire logical line	1269	to select a word; Left triple-click to select the entire logical line
979	(which can span multiple screen lines), unless modified by resource	1270	(which can span multiple screen lines), unless modified by resource
980	B<tripleclickwords>.	1271	B<tripleclickwords>.
981		1272
982	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1273	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
983	(Compile: I<frills>) will create a rectangular selection instead of a normal	1274	(Compile: I<frills>) will create a rectangular selection instead of a
984	one.	1275	normal one. In this mode, every selected row becomes its own line in the
		1276	selection, and trailing whitespace is visually underlined and removed from
		1277	the selection.
985		1278
986	=item B<Insertion>:	1279	=item B<Pasting>:
987		1280
988	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1281	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
989	an B<@@RXVT_NAME@@> window causes the current text selection to be	1282	window causes the value of the PRIMARY selection (or CLIPBOARD with the
990	inserted as if it had been typed on the keyboard.	1283	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1284
		1285	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1286	inserted too.
991		1287
992	=back	1288	=back
993		1289
994	=head1 CHANGING FONTS	1290	=head1 CHANGING FONTS
995		1291
996	Changing fonts (or font sizes, respectively) via the keypad is not yet	1292	Changing fonts (or font sizes, respectively) via the keypad is not yet
997	supported in rxvt-unicode. Bug me if you need this.	1293	supported in rxvt-unicode. Bug me if you need this.
998		1294
999	You can, however, switch fonts at runtime using escape sequences (and	1295	You can, however, switch fonts at runtime using escape sequences, e.g.:
1000	therefore using the menubar), e.g.:
1001		1296
1002	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1297	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1298
		1299	You can use keyboard shortcuts, too:
		1300
		1301	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1302	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1003		1303
1004	rxvt-unicode will automatically re-apply these fonts to the output so far.	1304	rxvt-unicode will automatically re-apply these fonts to the output so far.
1005		1305
1006	=head1 ISO 14755 SUPPORT	1306	=head1 ISO 14755 SUPPORT
1007		1307
1008	ISO 14755 is a standard for entering and viewing unicode characters	1308	ISO 14755 is a standard for entering and viewing unicode characters
1009	and character codes using the keyboard. It consists of 4 parts. The	1309	and character codes using the keyboard. It consists of 4 parts. The
1010	first part is available rxvt-unicode has been compiled with	1310	first part is available if rxvt-unicode has been compiled with
1011	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1311	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1012	with C<--enable-iso14755>.	1312	with C<--enable-iso14755>.
1013		1313
1014	=over 4	1314	=over 4
1015		1315
…		…
1035	This mode lets you input characters representing the keycap symbols of	1335	This mode lets you input characters representing the keycap symbols of
1036	your keyboard, if representable in the current locale encoding.	1336	your keyboard, if representable in the current locale encoding.
1037		1337
1038	Start by pressing C<Control> and C<Shift> together, then releasing	1338	Start by pressing C<Control> and C<Shift> together, then releasing
1039	them. The next special key (cursor keys, home etc.) you enter will not	1339	them. The next special key (cursor keys, home etc.) you enter will not
1040	invoke it's usual function but instead will insert the corresponding	1340	invoke its usual function but instead will insert the corresponding
1041	keycap symbol. The symbol will only be entered when the key has been	1341	keycap symbol. The symbol will only be entered when the key has been
1042	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1342	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1043	C<ISO Level 2 Switch>, although your intention might have been to enter a	1343	C<ISO Level 2 Switch>, although your intention might have been to enter a
1044	reverse tab (Shift-Tab).	1344	reverse tab (Shift-Tab).
1045		1345
…		…
1078	=head1 COLORS AND GRAPHICS	1378	=head1 COLORS AND GRAPHICS
1079		1379
1080	In addition to the default foreground and background colours,	1380	In addition to the default foreground and background colours,
1081	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1381	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1082	high-intensity bold/blink versions of the same). Here is a list of the	1382	high-intensity bold/blink versions of the same). Here is a list of the
1083	colours with their B<rgb.txt> names.	1383	colours with their names.
1084		1384
1085	=begin table	1385	=begin table
1086		1386
1087	B<color0> (black) = Black	1387	B<color0> (black) = Black
1088	B<color1> (red) = Red3	1388	B<color1> (red) = Red3
…		…
1108	It is also possible to specify the colour values of B<foreground>,	1408	It is also possible to specify the colour values of B<foreground>,
1109	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1409	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1110	a number 0-15, as a convenient shorthand to reference the colour name of	1410	a number 0-15, as a convenient shorthand to reference the colour name of
1111	color0-color15.	1411	color0-color15.
1112		1412
		1413	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1414	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1415	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1416	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1417
		1418	Together, all those colours implement the 88 colour xterm colours. Only
		1419	the first 16 can be changed using resources currently, the rest can only
		1420	be changed via command sequences ("escape codes").
		1421
1113	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1422	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1114	always swapping the foreground/background colours. This is in contrast to	1423	always swapping the foreground/background colours. This is in contrast to
1115	I<xterm>(1) where the colours are only swapped if they have not otherwise	1424	I<xterm>(1) where the colours are only swapped if they have not otherwise
1116	been specified. For example,	1425	been specified. For example,
1117		1426
…		…
1122	would yield White on Black, while on I<xterm>(1) it would yield Black	1431	would yield White on Black, while on I<xterm>(1) it would yield Black
1123	on White.	1432	on White.
1124		1433
1125	=back	1434	=back
1126		1435
		1436	=head2 ALPHA CHANNEL SUPPORT
		1437
		1438	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1439	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1440	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1441	in addition to the ones provided by X, where the additional A component
		1442	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1443	transparent). You can also prefix any color with C<[percent]>, where
		1444	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1445	the color, where C<0> is completely transparent and C<100> is completelxy
		1446	opaque.
		1447
		1448	You probably need to specify B<"-depth 32">, too, and have the luck that
		1449	your X-server uses ARGB pixel layout, as X is far from just supporting
		1450	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1451
		1452	For example, the following selects an almost completely transparent red
		1453	background, and an almost opaque pink foreground:
		1454
		1455	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1456
		1457	I<Please note that transparency of any kind if completely unsupported by
		1458	the author. Don't bug him with installation questions!>
		1459
1127	=head1 ENVIRONMENT	1460	=head1 ENVIRONMENT
1128		1461
1129	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1462	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1130		1463
1131	=over 4	1464	=over 4
1132		1465
1133	=item B<TERM>	1466	=item B<TERM>
1134		1467
1135	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1468	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1136	resources or on the commandline.	1469	resources or on the command line.
1137		1470
1138	=item B<COLORTERM>	1471	=item B<COLORTERM>
1139		1472
1140	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1473	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1141	compiled with XPM support, and optionally with the added extension	1474	compiled with XPM support, and optionally with the added extension
1142	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1475	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1143		1476
1144	=item B<COLORFGBG>	1477	=item B<COLORFGBG>
1145		1478
…		…
1163	C<--with-terminfo=PATH>.	1496	C<--with-terminfo=PATH>.
1164		1497
1165	=item B<DISPLAY>	1498	=item B<DISPLAY>
1166		1499
1167	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1500	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1168	display in it's child processes.	1501	display in its child processes.
1169		1502
1170	=item B<SHELL>	1503	=item B<SHELL>
1171		1504
1172	The shell to be used for command execution, defaults to C</bin/sh>.	1505	The shell to be used for command execution, defaults to C</bin/sh>.
1173
1174	=item B<RXVTPATH>
1175
1176	The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1177	files.
1178
1179	=item B<PATH>
1180
1181	Used in the same way as C<RXVTPATH>.
1182		1506
1183	=item B<RXVT_SOCKET>	1507	=item B<RXVT_SOCKET>
1184		1508
1185	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1509	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1186	@@RXVT_NAME@@d(1).	1510	@@RXVT_NAME@@d(1).
1187		1511
1188	Default C<< $HOME/.rxvt-unicode-<nodename >>.	1512	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1189		1513
1190	=item B<HOME>	1514	=item B<HOME>
1191		1515
1192	Used to locate the default directory for the unix domain socket for	1516	Used to locate the default directory for the unix domain socket for
1193	daemon communications and to locate various resource files (such as	1517	daemon communications and to locate various resource files (such as
…		…
1214		1538
1215	=back	1539	=back
1216		1540
1217	=head1 SEE ALSO	1541	=head1 SEE ALSO
1218		1542
1219	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1543	@@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)
1220
1221	=head1 BUGS
1222
1223	Check the BUGS file for an up-to-date list.
1224
1225	Cursor change support is not yet implemented.
1226
1227	Click-and-drag doesn't work with X11 mouse report overriding.
1228		1544
1229	=head1 CURRENT PROJECT COORDINATOR	1545	=head1 CURRENT PROJECT COORDINATOR
1230		1546
1231	=over 4	1547	=over 4
1232		1548
1233	=item Project Coordinator	1549	=item Project Coordinator
1234		1550
1235	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1551	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1236		1552
1237	L<http://software.schmorp.de/#rxvt-unicode>	1553	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1238		1554
1239	=back	1555	=back
1240		1556
1241	=head1 AUTHORS	1557	=head1 AUTHORS
1242		1558
…		…
1264		1580
1265	Project Coordinator (changes.txt 2.21a to 2.4.5)	1581	Project Coordinator (changes.txt 2.21a to 2.4.5)
1266		1582
1267	=item Geoff Wing L<< <gcw@pobox.com> >>	1583	=item Geoff Wing L<< <gcw@pobox.com> >>
1268		1584
1269	Rewrote screen display and text selection routines. Project Coordinator	1585	Rewrote screen display and text selection routines.
		1586
1270	(changes.txt 2.4.6 - rxvt-unicode)	1587	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1271		1588
1272	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1589	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1273		1590
1274	Forked rxvt-unicode, rewrote most of the display code and internal	1591	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1275	character handling to store text in unicode, improve xterm	1592	extension, random hacks, numerous bugfixes and extensions.
1276	compatibility and apply numerous other bugfixes and extensions.
1277		1593
1278	Project Coordinator (Changes 1.0 -)	1594	Project Coordinator (Changes 1.0 -)
1279		1595
		1596	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1597
		1598	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1599
1280	=back	1600	=back
1281		1601

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.58 by root, Wed Feb 16 21:49:36 2005 UTC vs. Revision 1.133 by ayin, Sat Jul 28 20:15:18 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.58 by root, Wed Feb 16 21:49:36 2005 UTC vs.
Revision 1.133 by ayin, Sat Jul 28 20:15:18 2007 UTC