ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	asked questions and answer to them and some common problems.	23	frequently asked questions and answer to them and some common
		24	problems. That document is also accessible on the World-Wide-Web at
		25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
21		26
22	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
23		28
24	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
26	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
27	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
28	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
29	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
30	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
31	fine, though. A somewhat difficult case are left-to-right scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
32	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
33	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
34	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
35	change.	40	change.
36		41
37	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
38	me recommend C<mlterm>, which is a very userfriendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
39	terminal emulator. In fact, the reason rxvt-unicode was born was solely	44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
40	because the author couldn't get C<mlterm> to use one font for latin1 and	45	because the author couldn't get C<mlterm> to use one font for latin1 and
41	another for japanese.	46	another for japanese.
42		47
43	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
44	display characters: The idea of a single unicode font which many other	49	display characters: The idea of a single unicode font which many other
45	programs force onto it's users never made sense to me: You should be able	50	programs force onto its users never made sense to me: You should be able
46	to choose any font for any script freely.	51	to choose any font for any script freely.
47		52
48	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
49	it's predecessor, supports things such as XFT and ISO 14755 that are handy	54	its predecessor, supports things such as XFT and ISO 14755 that are handy
50	in i18n-environments, is faster, and has a lot less bugs than the original	55	in i18n-environments, is faster, and has a lot bugs less than the original
51	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
52		57
53	It is still faithfully following the original rxvt idea of being lean	58	It is still faithfully following the original rxvt idea of being lean
54	and nice on resources: for example, you can still configure rxvt-unicode	59	and nice on resources: for example, you can still configure rxvt-unicode
55	without most of it's features to get a lean binary. It also comes with	60	without most of its features to get a lean binary. It also comes with
56	a client/daemon pair that lets you open any number of terminal windows	61	a client/daemon pair that lets you open any number of terminal windows
57	from within a single process, which makes startup time very fast and	62	from within a single process, which makes startup time very fast and
58	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
60		65
61	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
62	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
63	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
64		69
65	=head1 OPTIONS	70	=head1 OPTIONS
66		71
67	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	72	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
87		92
88	Print out a message describing available options.	93	Print out a message describing available options.
89		94
90	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
91		96
92	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
93	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
94	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
		100
		101	=item B<-depth> I<bitdepth>
		102
		103	Compile I<frills>: Attempt to find a visual with the given bit depth;
		104	resource B<depth>.
		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
		114	visual ids).
95		115
96	=item B<-geometry> I<geom>	116	=item B<-geometry> I<geom>
97		117
98	Window geometry (B<-g> still respected); resource B<geometry>.	118	Window geometry (B<-g> still respected); resource B<geometry>.
99		119
…		…
101		121
102	Turn on/off simulated reverse video; resource B<reverseVideo>.	122	Turn on/off simulated reverse video; resource B<reverseVideo>.
103		123
104	=item B<-j>|B<+j>	124	=item B<-j>|B<+j>
105		125
106	Turn on/off jump scrolling; resource B<jumpScroll>.	126	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
107		127
108	=item B<-ip>|B<+ip>	128	=item B<-ss>|B<+ss>
109		129
110	Turn on/off inheriting parent window's pixmap. Alternative form is	130	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
111	B<-tr>; resource B<inheritPixmap>.
112		131
113	=item B<-fade> I<number>	132	=item B<-fade> I<number>
114		133
115	Fade the text by the given percentage when focus is lost. resource B<fading>.	134	Fade the text by the given percentage when focus is lost. Small values
		135	fade a little only, 100 completely replaces all colours by the fade
		136	colour; resource B<fading>.
116		137
117	=item B<-tint> I<colour>	138	=item B<-fadecolor> I<colour>
118		139
119	Tint the transparent background pixmap with the given colour when	140	Fade to this colour when fading is used (see B<-fade>). The default colour
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	141	is opaque black. resource B<fadeColor>.
121	option that can be used to brighten or darken the image in addition to
122	tinting it.
123		142
124	=item B<-sh>	143	=item B<-icon> I<file>
125		144
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	145	Compile I<pixbuf>: Use the specified image as application icon. This
127	background image in addition to tinting it (i.e. B<-tint> must be	146	is used by many window managers, taskbars and pagers to represent the
128	specified, too, e.g. C<-tint white>).	147	application window; resource I<iconFile>.
129		148
130	=item B<-bg> I<colour>	149	=item B<-bg> I<colour>
131		150
132	Window background colour; resource B<background>.	151	Window background colour; resource B<background>.
133		152
134	=item B<-fg> I<colour>	153	=item B<-fg> I<colour>
135		154
136	Window foreground colour; resource B<foreground>.	155	Window foreground colour; resource B<foreground>.
137
138	=item B<-pixmap> I<file[;geom]>
139
140	Compile I<XPM>: Specify XPM file for the background and also optionally
141	specify its scaling with a geometry string. Note you may need to
142	add quotes to avoid special shell interpretation of the C<;> in the
143	command-line; resource B<backgroundPixmap>.
144		156
145	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
146		158
147	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
148		160
…		…
160	resource B<borderColor>.	172	resource B<borderColor>.
161		173
162	=item B<-fn> I<fontlist>	174	=item B<-fn> I<fontlist>
163		175
164	Select the fonts to be used. This is a comma separated list of font names	176	Select the fonts to be used. This is a comma separated list of font names
165	that are used in turn when trying to display Unicode characters. The	177	that are checked in order when trying to find glyphs for characters. The
166	first font defines the cell size for characters; other fonts might be	178	first font defines the cell size for characters; other fonts might be
167	smaller, but not (in general) larger. A (hopefully) reasonable default	179	smaller, but not (in general) larger. A (hopefully) reasonable default
168	font list is always appended to it. See resource B<font> for more details.	180	font list is always appended to it. See resource B<font> for more details.
169		181
170	In short, to specify an X11 core font, just specify it's name or prefix it	182	In short, to specify an X11 core font, just specify its name or prefix it
171	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
172	e.g.:	184	e.g.:
173		185
174	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
175	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
177	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178	section of @@RXVT_NAME@@(7).	190	section of @@RXVT_NAME@@(7).
179		191
180	=item B<-fb> I<fontlist>	192	=item B<-fb> I<fontlist>
181		193
182	Compile font-styles: The bold font list to use when bold characters are to	194	Compile I<font-styles>: The bold font list to use when B<bold> characters
183	be printed. See resource B<boldFont> for details.	195	are to be printed. See resource B<boldFont> for details.
184		196
185	=item B<-fi> I<fontlist>	197	=item B<-fi> I<fontlist>
186		198
187	Compile font-styles: The italic font list to use when bold characters are to	199	Compile I<font-styles>: The italic font list to use when I<italic>
188	be printed. See resource B<italicFont> for details.	200	characters are to be printed. See resource B<italicFont> for details.
189		201
190	=item B<-fbi> I<fontlist>	202	=item B<-fbi> I<fontlist>
191		203
192	Compile font-styles: The bold italic font list to use when bold characters are to	204	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193	be printed. See resource B<boldItalicFont> for details.	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
		206	for details.
		207
		208	=item B<-is>|B<+is>
		209
		210	Compile I<font-styles>: Bold/Blink font styles imply high intensity
		211	foreground/background (default). See resource B<intensityStyles> for
		212	details.
194		213
195	=item B<-name> I<name>	214	=item B<-name> I<name>
196		215
197	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
198	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
214		233
215	=item B<-sb>|B<+sb>	234	=item B<-sb>|B<+sb>
216		235
217	Turn on/off scrollbar; resource B<scrollBar>.	236	Turn on/off scrollbar; resource B<scrollBar>.
218		237
		238	=item B<-sr>|B<+sr>
		239
		240	Put scrollbar on right/left; resource B<scrollBar_right>.
		241
		242	=item B<-st>|B<+st>
		243
		244	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		245	resource B<scrollBar_floating>.
		246
219	=item B<-si>|B<+si>	247	=item B<-si>|B<+si>
220		248
221	Turn on/off scroll-to-bottom on TTY output inhibit; resource	249	Turn on/off scroll-to-bottom on TTY output inhibit; resource
222	B<scrollTtyOutput> has opposite effect.	250	B<scrollTtyOutput> has opposite effect.
223		251
…		…
229	=item B<-sw>|B<+sw>	257	=item B<-sw>|B<+sw>
230		258
231	Turn on/off scrolling with the scrollback buffer as new lines appear.	259	Turn on/off scrolling with the scrollback buffer as new lines appear.
232	This only takes effect if B<-si> is also given; resource	260	This only takes effect if B<-si> is also given; resource
233	B<scrollWithBuffer>.	261	B<scrollWithBuffer>.
234
235	=item B<-sr>|B<+sr>
236
237	Put scrollbar on right/left; resource B<scrollBar_right>.
238
239	=item B<-st>|B<+st>
240
241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
242	resource B<scrollBar_floating>.
243		262
244	=item B<-ptab>|B<+ptab>	263	=item B<-ptab>|B<+ptab>
245		264
246	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
247	actual wide characters in the screen buffer, which makes it possible to	266	actual wide characters in the screen buffer, which makes it possible to
…		…
251		270
252	=item B<-bc>|B<+bc>	271	=item B<-bc>|B<+bc>
253		272
254	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
255		274
		275	=item B<-uc>|B<+uc>
		276
		277	Make the cursor underlined; resource B<cursorUnderline>.
		278
256	=item B<-iconic>	279	=item B<-iconic>
257		280
258	Start iconified, if the window manager supports that option.	281	Start iconified, if the window manager supports that option.
259	Alternative form is B<-ic>.	282	Alternative form is B<-ic>.
260		283
…		…
276		299
277	=item B<-bl>	300	=item B<-bl>
278		301
279	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	302	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
280	if honoured by the WM, the rxvt-unicode window will not have window	303	if honoured by the WM, the rxvt-unicode window will not have window
281	decorations; resource B<borderLess>.	304	decorations; resource B<borderLess>. If the window manager does not
		305	support MWM hints (e.g. kwin), enables override-redirect mode.
		306
		307	=item B<-override-redirect>
		308
		309	Compile I<frills>: Sets override-redirect on the window; resource
		310	B<override-redirect>.
		311
		312	=item B<-dockapp>
		313
		314	Sets the initial state of the window to WithdrawnState, which makes
		315	window managers that support this extension treat it as a dockapp.
		316
		317	=item B<-sbg>
		318
		319	Compile I<frills>: Disable the usage of the built-in block graphics/line
		320	drawing characters and just rely on what the specified fonts provide. Use
		321	this if you have a good font and want to use its block graphic glyphs;
		322	resource B<skipBuiltinGlyphs>.
282		323
283	=item B<-lsp> I<number>	324	=item B<-lsp> I<number>
284		325
285	Compile I<frills>: Lines (pixel height) to insert between each row of	326	Compile I<frills>: Lines (pixel height) to insert between each row of
286	the display. Useful to work around font rendering problems; resource	327	the display. Useful to work around font rendering problems; resource
287	B<linespace>.	328	B<lineSpace>.
		329
		330	=item B<-letsp> I<number>
		331
		332	Compile I<frills>: Amount to adjust the computed character width by
		333	to control overall letter spacing. Negative values will tighten up the
		334	letter spacing, positive values will space letters out more. Useful to
		335	work around odd font metrics; resource B<letterSpace>.
288		336
289	=item B<-tn> I<termname>	337	=item B<-tn> I<termname>
290		338
291	This option specifies the name of the terminal type to be set in the	339	This option specifies the name of the terminal type to be set in the
292	B<TERM> environment variable. This terminal type must exist in the	340	B<TERM> environment variable. This terminal type must exist in the
…		…
301	given on the command line. If this option is used, it must be the last	349	given on the command line. If this option is used, it must be the last
302	on the command-line. If there is no B<-e> option then the default is to	350	on the command-line. If there is no B<-e> option then the default is to
303	run the program specified by the B<SHELL> environment variable or,	351	run the program specified by the B<SHELL> environment variable or,
304	failing that, I<sh(1)>.	352	failing that, I<sh(1)>.
305		353
		354	Please note that you must specify a program with arguments. If you want to
		355	run shell commands, you have to specify the shell, like this:
		356
		357	@@RXVT_NAME@@ -e sh -c "shell commands"
		358
306	=item B<-title> I<text>	359	=item B<-title> I<text>
307		360
308	Window title (B<-T> still respected); the default title is the basename	361	Window title (B<-T> still respected); the default title is the basename
309	of the program specified after the B<-e> option, if any, otherwise the	362	of the program specified after the B<-e> option, if any, otherwise the
310	application name; resource B<title>.	363	application name; resource B<title>.
…		…
341	for more info.	394	for more info.
342		395
343	=item B<-tcw>	396	=item B<-tcw>
344		397
345	Change the meaning of triple-click selection with the left mouse	398	Change the meaning of triple-click selection with the left mouse
		399	button. Only effective when the original (non-perl) selection code is
346	button. Instead of selecting a full line it will extend the selection the	400	in-use. Instead of selecting a full line it will extend the selection to
347	end of the logical line only. resource B<tripleclickwords>.	401	the end of the logical line only. resource B<tripleclickwords>.
348		402
349	=item B<-insecure>	403	=item B<-insecure>
350		404
351	Enable "insecure" mode, which currently enables most of the escape	405	Enable "insecure" mode, which currently enables most of the escape
352	sequences that echo strings. See the resource B<insecure> for more	406	sequences that echo strings. See the resource B<insecure> for more
…		…
366	=item B<-ssr>|B<+ssr>	420	=item B<-ssr>|B<+ssr>
367		421
368	Turn on/off secondary screen scroll (default enabled); resource	422	Turn on/off secondary screen scroll (default enabled); resource
369	B<secondaryScroll>.	423	B<secondaryScroll>.
370		424
		425	=item B<-hold>|B<+hold>
		426
		427	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		428	will not immediately destroy its window when the program executed within
		429	it exits. Instead, it will wait till it is being killed or closed by the
		430	user; resource B<hold>.
		431
		432	=item B<-cd> I<path>
		433
		434	Sets the working directory for the shell (or the command specified via
		435	B<-e>). The I<path> must be an absolute path and it must exist for
		436	@@RXVT_NAME@@ to start; resource B<chdir>.
		437
371	=item B<-xrm> I<resourcestring>	438	=item B<-xrm> I<string>
372		439
373	No effect on rxvt-unicode. Simply passes through an argument to be made	440	Works like the X Toolkit option of the same name, by adding the I<string>
374	available in the instance's argument list. Appears in I<WM_COMMAND> in	441	as if it were specified in a resource file. Resource values specified this
375	some window managers.	442	way take precedence over all other resource specifications.
		443
		444	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		445	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		446	options can be specified as long-options on the commandline, so use
		447	of B<-xrm> is mostly limited to cases where you want to specify other
		448	resources (e.g. for input methods) or for compatibility with other
		449	programs.
		450
		451	=item B<-keysym.>I<sym> I<string>
		452
		453	Remap a key symbol. See resource B<keysym>.
		454
		455	=item B<-embed> I<windowid>
		456
		457	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		458	which enables applications to easily embed a terminal.
		459
		460	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		461	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		462	quite a bit, so don't expect it to keep some specific state. It's best to
		463	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		464
		465	The window will not be destroyed when @@RXVT_NAME@@ exits.
		466
		467	It might be useful to know that @@RXVT_NAME@@ will not close file
		468	descriptors passed to it (except for stdin/out/err, of course), so you
		469	can use file descriptors to communicate with the programs within the
		470	terminal. This works regardless of whether the C<-embed> option was used or
		471	not.
		472
		473	Here is a short Gtk2-perl snippet that illustrates how this option can be
		474	used (a longer example is in F<doc/embed>):
		475
		476	my $rxvt = new Gtk2::Socket;
		477	$rxvt->signal_connect_after (realize => sub {
		478	my $xid = $_[0]->window->get_xid;
		479	system "@@RXVT_NAME@@ -embed $xid &";
		480	});
		481
		482	=item B<-pty-fd> I<file descriptor>
		483
		484	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		485	pair but instead use the given file descriptor as the tty master. This is
		486	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		487	without having to run a program within it.
		488
		489	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		490	entries and will not tinker with pty/tty permissions - you have to do that
		491	yourself if you want that.
		492
		493	As an extremely special case, specifying C<-1> will completely suppress
		494	pty/tty operations, which is probably only useful in conjunction with some
		495	perl extension that manages the terminal.
		496
		497	Here is a example in perl that illustrates how this option can be used (a
		498	longer example is in F<doc/pty-fd>):
		499
		500	use IO::Pty;
		501	use Fcntl;
		502
		503	my $pty = new IO::Pty;
		504	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		505	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		506	close $pty;
		507
		508	# now communicate with rxvt
		509	my $slave = $pty->slave;
		510	while (<$slave>) { print $slave "got <$_>\n" }
		511
		512	=item B<-pe> I<string>
		513
		514	Comma-separated list of perl extension scripts to use (or not to use) in
		515	this terminal instance. See resource B<perl-ext> for details.
376		516
377	=back	517	=back
378		518
379	=head1 RESOURCES (available also as long-options)	519	=head1 RESOURCES
380		520
381	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	521	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
382	options) compiled into your version.	522	options) compiled into your version. All resources are also available as
		523	long-options.
383		524
384	There are two different methods that @@RXVT_NAME@@ can use to get the	525	You can set and change the resources using X11 tools like B<xrdb>. Many
385	Xresource data: using the X libraries (Xrm*-functions) or internal	526	distribution do also load settings from the B<~/.Xresources> file when X
386	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	527	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
387	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	528	with later settings overwriting earlier ones:
388	resources using X11 tools like B<xset>. Many distribution do also load
389	settings from the B<~/.Xresources> file when X starts.
390		529
391	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	530	1. app-defaults file in $XAPPLRESDIR
392	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	531	2. $HOME/.Xdefaults
393	set in XAPPLOADDIR/URxvt (compile-time defined: usually	532	3. RESOURCE_MANAGER property on root-window of screen 0
394	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	533	4. SCREEN_RESOURCES property on root-window of the current screen
395	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	534	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		535	6. resources specified via -xrm on the commandline
		536
396	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	537	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
397	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	538	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
398	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	539	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
399	easily configured, while the class name B<URxvt> allows resources	540	configured, while the class name B<URxvt> allows resources unique to
400	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	541	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
401	shared between different B<@@RXVT_NAME@@> configurations. If no	542	configurations. If no resources are specified, suitable defaults will
402	resources are specified, suitable defaults will be used. Command-line	543	be used. Command-line arguments can be used to override resource
403	arguments can be used to override resource settings. The following	544	settings. The following resources are supported (you might want to
404	resources are allowed:	545	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		546	extensions not documented here):
405		547
406	=over 4	548	=over 4
		549
		550	=item B<depth:> I<bitdepth>
		551
		552	Compile I<xft>: Attempt to find a visual with the given bit depth;
		553	option B<-depth>.
		554
		555	=item B<buffered:> I<boolean>
		556
		557	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		558	On some card/driver combination enabling it slightly decreases
		559	performance, on most it greatly helps it. The slowdown is small, so it
		560	should normally be enabled.
407		561
408	=item B<geometry:> I<geom>	562	=item B<geometry:> I<geom>
409		563
410	Create the window with the specified X window geometry [default 80x24];	564	Create the window with the specified X window geometry [default 80x24];
411	option B<-geometry>.	565	option B<-geometry>.
…		…
425	Use the specified colour for the colour value I<n>, where 0-7	579	Use the specified colour for the colour value I<n>, where 0-7
426	corresponds to low-intensity (normal) colours and 8-15 corresponds to	580	corresponds to low-intensity (normal) colours and 8-15 corresponds to
427	high-intensity (bold = bright foreground, blink = bright background)	581	high-intensity (bold = bright foreground, blink = bright background)
428	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	582	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
429	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	583	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
430	names used are listed in the B<COLORS AND GRAPHICS> section.	584	names used are listed in the B<COLOURS AND GRAPHICS> section.
431		585
432	Colours higher than 15 cannot be set using resources (yet), but can be	586	Colours higher than 15 cannot be set using resources (yet), but can be
433	changed using an escape command (see @@RXVT_NAME@@(7)).	587	changed using an escape command (see @@RXVT_NAME@@(7)).
434		588
435	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	589	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
446	=item B<colorUL:> I<colour>	600	=item B<colorUL:> I<colour>
447		601
448	Use the specified colour to display underlined characters when the	602	Use the specified colour to display underlined characters when the
449	foreground colour is the default.	603	foreground colour is the default.
450		604
451	=item B<colorRV:> I<colour>
452
453	Use the specified colour as the background for reverse video
454	characters.
455
456	=item B<underlineColor:> I<colour>	605	=item B<underlineColor:> I<colour>
457		606
458	If set, use the specified colour as the colour for the underline	607	If set, use the specified colour as the colour for the underline
459	itself. If unset, use the foreground colour.	608	itself. If unset, use the foreground colour.
		609
		610	=item B<highlightColor:> I<colour>
		611
		612	If set, use the specified colour as the background for highlighted
		613	characters. If unset, use reverse video.
		614
		615	=item B<highlightTextColor:> I<colour>
		616
		617	If set and highlightColor is set, use the specified colour as the
		618	foreground for highlighted characters.
460		619
461	=item B<cursorColor:> I<colour>	620	=item B<cursorColor:> I<colour>
462		621
463	Use the specified colour for the cursor. The default is to use the	622	Use the specified colour for the cursor. The default is to use the
464	foreground colour; option B<-cr>.	623	foreground colour; option B<-cr>.
…		…
471		630
472	=item B<reverseVideo:> I<boolean>	631	=item B<reverseVideo:> I<boolean>
473		632
474	B<True>: simulate reverse video by foreground and background colours;	633	B<True>: simulate reverse video by foreground and background colours;
475	option B<-rv>. B<False>: regular screen colours [default]; option	634	option B<-rv>. B<False>: regular screen colours [default]; option
476	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	635	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
477		636
478	=item B<jumpScroll:> I<boolean>	637	=item B<jumpScroll:> I<boolean>
479		638
480	B<True>: specify that jump scrolling should be used. When scrolling	639	B<True>: specify that jump scrolling should be used. When receiving lots
481	quickly, fewer screen updates are performed [default]; option B<-j>.	640	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		641	has been read, resulting in fewer updates while still displaying every
		642	received line; option B<-j>.
		643
482	B<False>: specify that smooth scrolling should be used; option B<+j>.	644	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		645	force a screen refresh on each new line it received; option B<+j>.
483		646
484	=item B<inheritPixmap:> I<boolean>	647	=item B<skipScroll:> I<boolean>
485		648
486	B<True>: make the background inherit the parent windows' pixmap, giving	649	B<True>: (the default) specify that skip scrolling should be used. When
487	artificial transparency. B<False>: do not inherit the parent windows'	650	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
488	pixmap.	651	(around 60 times per second), resulting in far fewer updates. This can
		652	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		653	option B<-ss>.
		654
		655	B<False>: specify that everything is to be displayed, even
		656	if the refresh is too fast for the human eye to read anything (or the
		657	monitor to display anything); option B<+ss>.
489		658
490	=item B<fading:> I<number>	659	=item B<fading:> I<number>
491		660
492	Fade the text by the given percentage when focus is lost.	661	Fade the text by the given percentage when focus is lost; option B<-fade>.
493		662
494	=item B<tintColor:> I<colour>	663	=item B<fadeColor:> I<colour>
495		664
496	Tint the transparent background pixmap with the given colour.	665	Fade to this colour, when fading is used (see B<fading:>). The default
		666	colour is black; option B<-fadecolor>.
497		667
498	=item B<shading:> I<number>	668	=item B<iconFile:> I<file>
499		669
500	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	670	Set the application icon pixmap; option B<-icon>.
501	image in addition to tinting it.
502		671
503	=item B<scrollColor:> I<colour>	672	=item B<scrollColor:> I<colour>
504		673
505	Use the specified colour for the scrollbar [default #B2B2B2].	674	Use the specified colour for the scrollbar [default #B2B2B2].
506		675
507	=item B<troughColor:> I<colour>	676	=item B<troughColor:> I<colour>
508		677
509	Use the specified colour for the scrollbar's trough area [default	678	Use the specified colour for the scrollbar's trough area [default
510	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	679	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511		680
512	=item B<borderColor:> I<colour>	681	=item B<borderColor:> I<colour>
513		682
514	The colour of the border around the text area and between the scrollbar	683	The colour of the border around the text area and between the scrollbar
515	and the text.	684	and the text.
516		685
517	=item B<backgroundPixmap:> I<file[;geom]>
518
519	Use the specified XPM file (note the `.xpm' extension is optional) for
520	the background and also optionally specify its scaling with a geometry
521	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
522	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
523	centre (percent). A scale of 0 displays the image with tiling. A scale
524	of 1 displays the image without any scaling. A scale of 2 to 9
525	specifies an integer number of images in that direction. No image will
526	be magnified beyond 10 times its original size. The maximum permitted
527	scale is 1000. [default 0x0+50+50]
528
529	=item B<menu:> I<file[;tag]>
530
531	Read in the specified menu file (note the `.menu' extension is
532	optional) and also optionally specify a starting tag to find. See the
533	reference documentation for details on the syntax for the menuBar.
534
535	=item B<path:> I<path>
536
537	Specify the colon-delimited search path for finding files (XPM and
538	menus), in addition to the paths specified by the B<RXVTPATH> and
539	B<PATH> environment variables.
540
541	=item B<font:> I<fontlist>	686	=item B<font:> I<fontlist>
542		687
543	Select the fonts to be used. This is a comma separated list of font	688	Select the fonts to be used. This is a comma separated list of font names
544	names that are used in turn when trying to display Unicode characters.	689	that are checked in order when trying to find glyphs for characters. The
545	The first font defines the cell size for characters; other fonts might	690	first font defines the cell size for characters; other fonts might be
546	be smaller, but not larger. A reasonable default font list is always	691	smaller, but not (in general) larger. A (hopefully) reasonable default
547	appended to it. option B<-fn>.	692	font list is always appended to it; option B<-fn>.
548		693
549	Each font can either be a standard X11 core font (XLFD) name, with	694	Each font can either be a standard X11 core font (XLFD) name, with
550	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	695	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
551		696
552	In addition, each font can be prefixed with additional hints and	697	In addition, each font can be prefixed with additional hints and
…		…
554	hint currently is C<codeset=codeset-name>, and this is only used for Xft	699	hint currently is C<codeset=codeset-name>, and this is only used for Xft
555	fonts.	700	fonts.
556		701
557	For example, this font resource	702	For example, this font resource
558		703
559	URxvt*font: 9x15bold,\	704	URxvt.font: 9x15bold,\
560	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	705	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
561	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	706	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
562	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	707	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
563	xft:Code2000:antialias=false	708	xft:Code2000:antialias=false
564		709
…		…
567	it is named first) and thus defines the character cell grid to be 9 pixels	712	it is named first) and thus defines the character cell grid to be 9 pixels
568	wide and 15 pixels high.	713	wide and 15 pixels high.
569		714
570	The second font is just used to add additional unicode characters not in	715	The second font is just used to add additional unicode characters not in
571	the base font, likewise the third, which is unfortunately non-bold, but	716	the base font, likewise the third, which is unfortunately non-bold, but
572	the bold version of the font does contain less characters, so this is a	717	the bold version of the font does contain fewer characters, so this is a
573	useful supplement.	718	useful supplement.
574		719
575	The third font is an Xft font with aliasing turned off, and the characters	720	The third font is an Xft font with aliasing turned off, and the characters
576	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	721	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
577	contains other characters, but we are not interested in them.	722	contains other characters, but we are not interested in them.
…		…
598	not possible, replacement fonts of the desired shape will be tried.	743	not possible, replacement fonts of the desired shape will be tried.
599		744
600	If set, but empty, then this specific style is disabled and the normal	745	If set, but empty, then this specific style is disabled and the normal
601	text font will being used for the given style.	746	text font will being used for the given style.
602		747
603	=item B<selectstyle:> I<mode>	748	=item B<intensityStyles:> I<boolean>
604		749
605	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	750	When font styles are not enabled, or this option is enabled (B<True>,
606	xterm style with 2.20 old word selection, or anything else which gives	751	option B<-is>, the default), bold/blink font styles imply high
607	xterm style selection.	752	intensity foreground/background colours. Disabling this option (B<False>,
608		753	option B<+is>) disables this behaviour, the high intensity colours are not
609	=item B<scrollstyle:> I<mode>	754	reachable.
610
611	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
612	the author's favourite..
613		755
614	=item B<title:> I<string>	756	=item B<title:> I<string>
615		757
616	Set window title string, the default title is the command-line	758	Set window title string, the default title is the command-line
617	specified after the B<-e> option, if any, otherwise the application	759	specified after the B<-e> option, if any, otherwise the application
…		…
626	=item B<mapAlert:> I<boolean>	768	=item B<mapAlert:> I<boolean>
627		769
628	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	770	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
629	de-iconify (map) on receipt of a bell character [default].	771	de-iconify (map) on receipt of a bell character [default].
630		772
		773	=item B<urgentOnBell:> I<boolean>
		774
		775	B<True>: set the urgency hint for the wm on receipt of a bell character.
		776	B<False>: do not set the urgency hint [default].
		777
		778	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		779
631	=item B<visualBell:> I<boolean>	780	=item B<visualBell:> I<boolean>
632		781
633	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	782	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
634	B<False>: no visual bell [default]; option B<+vb>.	783	B<False>: no visual bell [default]; option B<+vb>.
635		784
…		…
649		798
650	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	799	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
651	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	800	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
652	B<Shift-Print> to include the scrollback as well.	801	B<Shift-Print> to include the scrollback as well.
653		802
		803	The string will be interpreted as if typed into the shell as-is.
		804
		805	Example:
		806
		807	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		808
		809	This creates a new file in your home directory with the screen contents
		810	every time you hit C<Print>.
		811
		812	=item B<scrollstyle:> I<mode>
		813
		814	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		815	the author's favourite.
		816
		817	=item B<thickness:> I<number>
		818
		819	Set the scrollbar width in pixels.
		820
654	=item B<scrollBar:> I<boolean>	821	=item B<scrollBar:> I<boolean>
655		822
656	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	823	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657	disable the scrollbar; option B<+sb>.	824	disable the scrollbar; option B<+sb>.
658		825
…		…
677	B<False>: do not scroll to bottom when tty receives output; option	844	B<False>: do not scroll to bottom when tty receives output; option
678	B<+si>.	845	B<+si>.
679		846
680	=item B<scrollWithBuffer:> I<boolean>	847	=item B<scrollWithBuffer:> I<boolean>
681		848
682	B<True>: scroll with scrollback buffer when tty receives new lines (and	849	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
683	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	850	try to show the same lines) and B<scrollTtyOutput> is False; option
684	with scrollback buffer when tty recieves new lines; option B<-sw>.	851	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		852	new lines; option B<+sw>.
685		853
686	=item B<scrollTtyKeypress:> I<boolean>	854	=item B<scrollTtyKeypress:> I<boolean>
687		855
688	B<True>: scroll to bottom when a non-special key is pressed. Special keys	856	B<True>: scroll to bottom when a non-special key is pressed. Special keys
689	are those which are intercepted by rxvt-unicode for special handling and	857	are those which are intercepted by rxvt-unicode for special handling and
…		…
708	=item B<borderLess:> I<boolean>	876	=item B<borderLess:> I<boolean>
709		877
710	Set MWM hints to request a borderless window, i.e. if honoured by the	878	Set MWM hints to request a borderless window, i.e. if honoured by the
711	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	879	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
712		880
		881	=item B<skipBuiltinGlyphs:> I<boolean>
		882
		883	Compile I<frills>: Disable the usage of the built-in block graphics/line
		884	drawing characters and just rely on what the specified fonts provide. Use
		885	this if you have a good font and want to use its block graphic glyphs;
		886	option B<-sbg>.
		887
713	=item B<termName:> I<termname>	888	=item B<termName:> I<termname>
714		889
715	Specifies the terminal type name to be set in the B<TERM> environment	890	Specifies the terminal type name to be set in the B<TERM> environment
716	variable; option B<-tn>.	891	variable; option B<-tn>.
717		892
718	=item B<linespace:> I<number>	893	=item B<lineSpace:> I<number>
719		894
720	Specifies number of lines (pixel height) to insert between each row of	895	Specifies number of lines (pixel height) to insert between each row of
721	the display [default 0]; option B<-lsp>.	896	the display [default 0]; option B<-lsp>.
722		897
723	=item B<meta8:> I<boolean>	898	=item B<meta8:> I<boolean>
…		…
737		912
738	=item B<cursorBlink:> I<boolean>	913	=item B<cursorBlink:> I<boolean>
739		914
740	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	915	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
741	option B<-bc>.	916	option B<-bc>.
		917
		918	=item B<cursorUnderline:> I<boolean>
		919
		920	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		921	option B<-uc>.
742		922
743	=item B<pointerBlank:> I<boolean>	923	=item B<pointerBlank:> I<boolean>
744		924
745	B<True>: blank the pointer when a key is pressed or after a set number	925	B<True>: blank the pointer when a key is pressed or after a set number
746	of seconds of inactivity. B<False>: the pointer is always visible	926	of seconds of inactivity. B<False>: the pointer is always visible
…		…
754		934
755	Mouse pointer background colour.	935	Mouse pointer background colour.
756		936
757	=item B<pointerBlankDelay:> I<number>	937	=item B<pointerBlankDelay:> I<number>
758		938
759	Specifies number of seconds before blanking the pointer [default 2].	939	Specifies number of seconds before blanking the pointer [default 2]. Use a
		940	large number (e.g. C<987654321>) to effectively disable the timeout.
760		941
761	=item B<backspacekey:> I<string>	942	=item B<backspacekey:> I<string>
762		943
763	The string to send when the backspace key is pressed. If set to B<DEC>	944	The string to send when the backspace key is pressed. If set to B<DEC>
764	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	945	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
765	(code 8) - which can be reversed with the appropriate DEC private mode	946	(code 8) - which can be reversed with the appropriate DEC private mode
766	escape sequence.	947	escape sequence.
767		948
768	=item B<deletekey:> I<string>	949	=item B<deletekey:> I<string>
769		950
…		…
771	pressed. If unset it will send the sequence traditionally associated	952	pressed. If unset it will send the sequence traditionally associated
772	with the B<Execute> key.	953	with the B<Execute> key.
773		954
774	=item B<cutchars:> I<string>	955	=item B<cutchars:> I<string>
775		956
776	The characters used as delimiters for double-click word selection. The	957	The characters used as delimiters for double-click word selection
777	built-in default:	958	(whitespace delimiting is added automatically if resource is given).
778		959
		960	When the perl selection extension is in use (the default if compiled
		961	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		962	characters will be created (if the resource exists, otherwise, no regex
		963	will be created). In this mode, characters outside ISO-8859-1 can be used.
		964
		965	When the selection extension is not used, only ISO-8859-1 characters can
		966	be used. If not specified, the built-in default is used:
		967
779	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	968	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
780		969
781	=item B<preeditType:> I<style>	970	=item B<preeditType:> I<style>
782		971
783	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	972	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
784		973
…		…
789	=item B<imLocale:> I<name>	978	=item B<imLocale:> I<name>
790		979
791	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	980	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
792	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	981	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
793	input extension to be able to input japanese characters while staying in	982	input extension to be able to input japanese characters while staying in
794	another locale. option B<-imlocale>.	983	another locale; option B<-imlocale>.
795		984
796	=item B<imFont:> I<fontset>	985	=item B<imFont:> I<fontset>
797		986
798	Specify the font-set used for XIM styles C<OverTheSpot> or	987	Specify the font-set used for XIM styles C<OverTheSpot> or
799	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	988	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
804		993
805	=item B<tripleclickwords:> I<boolean>	994	=item B<tripleclickwords:> I<boolean>
806		995
807	Change the meaning of triple-click selection with the left mouse	996	Change the meaning of triple-click selection with the left mouse
808	button. Instead of selecting a full line it will extend the selection to	997	button. Instead of selecting a full line it will extend the selection to
809	the end of the logical line only. option B<-tcw>.	998	the end of the logical line only; option B<-tcw>.
810		999
811	=item B<insecure:> I<boolean>	1000	=item B<insecure:> I<boolean>
812		1001
813	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1002	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
814	echo arbitrary strings like the icon name or the locale. This could be	1003	echo arbitrary strings like the icon name or the locale. This could be
815	abused if somebody gets 8-bit-clean access to your display, whether	1004	abused if somebody gets 8-bit-clean access to your display, whether
816	throuh a mail client displaying mail bodies unfiltered or though	1005	through a mail client displaying mail bodies unfiltered or through
817	write(1). Therefore, these sequences are disabled by default. (Note	1006	write(1) or any other means. Therefore, these sequences are disabled by
818	that other terminals, including xterm, have these sequences	1007	default. (Note that many other terminals, including xterm, have these
819	enabled by default). You can enable them by setting this boolean	1008	sequences enabled by default, which doesn't make it safer, though).
820	resource or specifying B<-insecure> as an option. At the moment, this	1009
821	enabled display-answer, locale, findfont, icon label and window title	1010	You can enable them by setting this boolean resource or specifying
822	requests as well as dynamic menubar dispatch.	1011	B<-insecure> as an option. At the moment, this enables display-answer,
		1012	locale, findfont, icon label and window title requests.
823		1013
824	=item B<modifier:> I<modifier>	1014	=item B<modifier:> I<modifier>
825		1015
826	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1016	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
827	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1017	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
831		1021
832	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1022	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
833	character is passed through. It may contain escape values as described	1023	character is passed through. It may contain escape values as described
834	in the entry on B<keysym> following.	1024	in the entry on B<keysym> following.
835		1025
836	=item B<secondaryScreen:> I<bool>	1026	=item B<secondaryScreen:> I<boolean>
837		1027
838	Turn on/off secondary screen (default enabled).	1028	Turn on/off secondary screen (default enabled).
839		1029
840	=item B<secondaryScroll:> I<bool>	1030	=item B<secondaryScroll:> I<boolean>
841		1031
842	Turn on/off secondary screen scroll (default enabled). If the this	1032	Turn on/off secondary screen scroll (default enabled). If this
843	option is enabled, scrolls on the secondary screen will change the	1033	option is enabled, scrolls on the secondary screen will change the
844	scrollback buffer and switching to/from the secondary screen will	1034	scrollback buffer and, when secondaryScreen is off, switching
845	instead scroll the screen up.	1035	to/from the secondary screen will instead scroll the screen up.
846		1036
		1037	=item B<hold>: I<boolean>
		1038
		1039	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1040	will not immediately destroy its window when the program executed within
		1041	it exits. Instead, it will wait till it is being killed or closed by the
		1042	user.
		1043
		1044	=item B<chdir>: I<path>
		1045
		1046	Sets the working directory for the shell (or the command specified via
		1047	B<-e>). The I<path> must be an absolute path and it must exist for
		1048	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1049	directory will be used; option B<-cd>.
		1050
847	=item B<keysym.>I<sym>: I<string>	1051	=item B<keysym.>I<sym>: I<action>
848		1052
849	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1053	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
850	intervening resource name B<keysym.> cannot be omitted.	1054	resource name B<keysym.> cannot be omitted.
851		1055
852	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1056	Using this resource, you can map key combinations such as
853	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1057	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
854	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1058	string than would normally result from that combination, making the
855	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1059	terminal scroll up or down the way you want it, or any other thing an
856	B<2>, B<3>, B<4>, B<5>.	1060	extension might provide.
		1061
		1062	The key combination that triggers the action, I<sym>, has the following format:
		1063
		1064	(modifiers-)key
		1065
		1066	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1067	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1068	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1069	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
857		1070
858	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1071	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
859	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1072	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
860	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1073	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
861	current application keymap mode state.	1074	current application keymap mode state.
862		1075
863	The spellings of I<key> can be obtained by using B<xev>(1) command or	1076	Due the the large number of modifier combinations, a key mapping will
864	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1077	match if I<at least> the specified identifiers are being set, and no other
		1078	key mappings with those and more bits are being defined. That means that
		1079	defining a mapping for C<a> will automatically provide definitions for
		1080	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1081	themselves. See the C<builtin:> action, below, for a way to work around
		1082	this when this is a problem.
		1083
		1084	The spelling of I<key> depends on your implementation of X. An easy way to
		1085	find a key name is to use the B<xev>(1) command. You can find a list by
		1086	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
865	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1087	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
866	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1088	value (B<0x0000 - 0xFFFF>).
867	performed in an exact manner; however, the closest match is assured.
868		1089
869	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1090	As with any resource value, the I<action> string may contain backslash
870	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1091	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
871	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1092	number), see RESOURCES in C<man 7 X> for further details.
872	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
873	can start or end with whitespace.
874		1093
875	Please note that you need to double the C<\> when using	1094	An action starts with an action prefix that selects a certain type
876	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1095	of action, followed by a colon. An action string without colons is
877	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1096	interpreted as a literal string to pass to the tty (as if it was
878	@@RXVT_NAME@@'s own processing).	1097	prefixed with C<string:>).
879		1098
880	You can define a range of keysyms in one shot by providing a I<string>	1099	The following action prefixes are known - extensions can provide
881	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1100	additional prefixes:
882	should be a character not used by the strings.
883		1101
884	Its usage can be demonstrated by an example:	1102	=over 4
885		1103
886	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>	1104	=item string:STRING
887		1105
888	The above line is equivalent to the following three lines:	1106	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1107	then the remaining C<STRING> will be passed to the program running in the
		1108	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1109	string C<echo rm -rf /> followed by a newline:
889		1110
890	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1111	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
891	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
892	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
893		1112
		1113	This could in theory be used to completely redefine your keymap.
		1114
		1115	=item command:STRING
		1116
894	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1117	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
895	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1118	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1119	the opposite of C<string:> - instead of sending it to the program running
		1120	in the terminal, it will be treated as if it were program output). This is
		1121	most useful to feed command sequences into @@RXVT_NAME@@.
		1122
896	example the following means "change the current locale to C<zh_CN.GBK>	1123	For example the following means "change the current locale to C<zh_CN.GBK>
897	when Control-Meta-c is being pressed":	1124	when Control-Meta-c is being pressed":
898		1125
899	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1126	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900		1127
901	The following example will map Control-Meta-1 and Control-Meta-2 to	1128	The following example will map Control-Meta-1 and Control-Meta-2 to
…		…
908	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1135	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
909	info):	1136	info):
910		1137
911	URxvt.keysym.M-C-3: command:\033[8;25;80t	1138	URxvt.keysym.M-C-3: command:\033[8;25;80t
912	URxvt.keysym.M-C-4: command:\033[8;48;110t	1139	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1140
		1141	=item builtin:
		1142
		1143	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1144	key binding existed for the key combination. The obvious use is to undo
		1145	the effect of existing bindings. The not so obvious use is to reinstate
		1146	bindings when another binding overrides too many modifiers.
		1147
		1148	For example if you overwrite the C<Insert> key you will disable
		1149	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
		1150	"holes" into the user-defined keymap using the C<builtin:> replacement:
		1151
		1152	URxvt.keysym.Insert: <my insert key sequence>
		1153	URxvt.keysym.S-Insert: builtin:
		1154
		1155	The first line defines a mapping for C<Insert> and I<any> combination
		1156	of modifiers. The second line re-establishes the default mapping for
		1157	C<Shift-Insert>.
		1158
		1159	=item builtin-string:
		1160
		1161	This action is mainly useful to restore string mappings for keys that
		1162	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1163	difficult to explain - basically, this action will send the string to the
		1164	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1165	action for it.
		1166
		1167	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
		1168	selection when you press C<Shift-Insert>. With the following bindings, it
		1169	would instead emit the (undocumented, but what applications running in the
		1170	terminal might expect) sequence C<ESC [ 2 $> instead:
		1171
		1172	URxvt.keysym.S-Insert: builtin-string:
		1173	URxvt.keysym.C-S-Insert: builtin:
		1174
		1175	The first line disables the paste functionality for that key
		1176	combination, and the second reinstates the default behaviour for
		1177	C<Control-Shift-Insert>, which would otherwise be overridden.
		1178
		1179	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1180	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1181	this:
		1182
		1183	URxvt.keysym.C-S-c: builtin-string:
		1184	URxvt.keysym.C-S-v: builtin-string:
		1185
		1186	=item EXTENSION:STRING
		1187
		1188	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
		1189	extension of the same name. The extension will be loaded automatically if
		1190	necessary.
		1191
		1192	Not all extensions define key actions, but popular extensions that do
		1193	include the I<selection> and I<matcher> extensions (documented in their
		1194	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1195	respectively).
		1196
		1197	From the silly examples department, this will rot13-"encrypt"
		1198	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1199	keyboards:
		1200
		1201	URxvt.keysym.M-C-c: selection:rot13
		1202
		1203	=item perl:STRING *DEPRECATED*
		1204
		1205	This is a deprecated way of passing key mappings to perl extensions. It is
		1206	still supported, but should not be used anymore.
		1207
		1208	=back
		1209
		1210	=item B<perl-ext-common>: I<string>
		1211
		1212	=item B<perl-ext>: I<string>
		1213
		1214	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1215	use in this terminal instance; option B<-pe>.
		1216
		1217	Extension names can be prefixed with a C<-> sign to prohibit using
		1218	them. This can be useful to selectively disable some extensions loaded
		1219	by default, or specified via the C<perl-ext-common> resource. For
		1220	example, C<default,-selection> will use all the default extensions except
		1221	C<selection>.
		1222
		1223	The default set includes the C<selection>, C<option-popup>,
		1224	C<selection-popup> and C<readline> extensions, any extensions that define
		1225	keybindings via C<BINDING> meta comments, extensions loaded because
		1226	their resources/commandline switches were used, and extensions which are
		1227	mentioned in B<keysym> resources.
		1228
		1229	Each extension is looked up in the library directories, loaded if
		1230	necessary, and bound to the current terminal instance. When the library
		1231	search path contains multiple extension files of the same name, then the
		1232	first one found will be used.
		1233
		1234	If both of these resources are the empty string, then the perl interpreter
		1235	will not be initialized. The rationale for having two options is that
		1236	B<perl-ext-common> will be used for extensions that should be available to
		1237	all instances, while B<perl-ext> is used for specific instances.
		1238
		1239	=item B<perl-eval>: I<string>
		1240
		1241	Perl code to be evaluated when all extensions have been registered. See
		1242	the @@RXVT_NAME@@perl(3) manpage.
		1243
		1244	=item B<perl-lib>: I<path>
		1245
		1246	Colon-separated list of additional directories that hold extension
		1247	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
		1248	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
		1249	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1250
		1251	See the @@RXVT_NAME@@perl(3) manpage.
		1252
		1253	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1254
		1255	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1256	details.
		1257
		1258	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1259
		1260	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1261	for details.
		1262
		1263	=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
		1264
		1265	This resource is deprecated and will be removed. Use a B<keysym> resource
		1266	instead, e.g.:
		1267
		1268	URxvt.keysym.M-s: searchable-scrollback:start
		1269
		1270	=item B<url-launcher>: I<string>
		1271
		1272	Specifies the program to be started with a URL argument. Used by the
		1273	C<selection-popup> and C<matcher> perl extensions.
		1274
		1275	=item B<transient-for>: I<windowid>
		1276
		1277	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1278
		1279	=item B<override-redirect>: I<boolean>
		1280
		1281	Compile I<frills>: Sets override-redirect for the terminal window, making
		1282	it almost invisible to window managers; option B<-override-redirect>.
		1283
		1284	=item B<iso14755:> I<boolean>
		1285
		1286	Turn on/off ISO 14755 (default enabled).
		1287
		1288	=item B<iso14755_52:> I<boolean>
		1289
		1290	Turn on/off ISO 14755 5.2 mode (default enabled).
		1291
		1292	=back
		1293
		1294	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1295
		1296	=over 4
		1297
		1298	=item B<-pixmap> I<file[;oplist]>
		1299
		1300	=item B<backgroundPixmap:> I<file[;oplist]>
		1301
		1302	Compile I<pixbuf>: Use the specified image file as the window's
		1303	background and also optionally specify a colon separated list of
		1304	operations to modify it. Note that you may need to quote the C<;>
		1305	character when using the command line option, as C<;> is usually a
		1306	metacharacter in shells. Supported operations are:
		1307
		1308	=over 4
		1309
		1310	=item B<WxH+X+Y>
		1311
		1312	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1313	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1314	scale of 0 disables scaling.
		1315
		1316	=item B<op=tile>
		1317
		1318	enables tiling
		1319
		1320	=item B<op=keep-aspect>
		1321
		1322	maintain the image aspect ratio when scaling
		1323
		1324	=item B<op=root-align>
		1325
		1326	use the position of the terminal window relative to the root window as
		1327	the image offset, simulating a root window background
		1328
		1329	=back
		1330
		1331	The default scale and position setting is C<100x100+50+50>.
		1332	Alternatively, a predefined set of templates can be used to achieve
		1333	the most common setups:
		1334
		1335	=over 4
		1336
		1337	=item B<style=tiled>
		1338
		1339	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1340
		1341	=item B<style=aspect-stretched>
		1342
		1343	the image is scaled to fill the whole window maintaining the aspect
		1344	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1345
		1346	=item B<style=stretched>
		1347
		1348	the image is scaled to fill the whole window. Equivalent to 100x100
		1349
		1350	=item B<style=centered>
		1351
		1352	the image is centered with no scaling. Equivalent to 0x0+50+50
		1353
		1354	=item B<style=root-tiled>
		1355
		1356	the image is tiled with no scaling and using 'root' positioning.
		1357	Equivalent to 0x0:op=tile:op=root-align
		1358
		1359	=back
		1360
		1361	If multiple templates are specified the last one wins. Note that a
		1362	template overrides all the scale, position and operations settings.
		1363
		1364	If used in conjunction with pseudo-transparency, the specified pixmap
		1365	will be blended over the transparent background using alpha-blending.
		1366
		1367	=item B<-tr>|B<+tr>
		1368
		1369	=item B<transparent:> I<boolean>
		1370
		1371	Turn on/off pseudo-transparency by using the root pixmap as background.
		1372
		1373	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1374	will be removed in future versions.
		1375
		1376	=item B<-tint> I<colour>
		1377
		1378	=item B<tintColor:> I<colour>
		1379
		1380	Tint the transparent background with the given colour. Note that a
		1381	black tint yields a completely black image while a white tint yields
		1382	the image unchanged.
		1383
		1384	=item B<-sh> I<number>
		1385
		1386	=item B<shading:> I<number>
		1387
		1388	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1389	A value of 100 means no shading.
		1390
		1391	=item B<-blr> I<HxV>
		1392
		1393	=item B<blurRadius:> I<HxV>
		1394
		1395	Apply gaussian blur with the specified radius to the transparent
		1396	background. If a single number is specified, the vertical and
		1397	horizontal radii are considered to be the same. Setting one of the
		1398	radii to 1 and the other to a large number creates interesting effects
		1399	on some backgrounds. The maximum radius value is 128. An horizontal or
		1400	vertical radius of 0 disables blurring.
		1401
		1402	=item B<path:> I<path>
		1403
		1404	Specify the colon-delimited search path for finding background image files.
913		1405
914	=back	1406	=back
915		1407
916	=head1 THE SCROLLBAR	1408	=head1 THE SCROLLBAR
917		1409
…		…
931	the normal text selection/insertion, hold either the Shift or the Meta	1423	the normal text selection/insertion, hold either the Shift or the Meta
932	(Alt) key while performing the desired mouse action.	1424	(Alt) key while performing the desired mouse action.
933		1425
934	If mouse reporting mode is active, the normal scrollbar actions are	1426	If mouse reporting mode is active, the normal scrollbar actions are
935	disabled -- on the assumption that we are using a fullscreen	1427	disabled -- on the assumption that we are using a fullscreen
936	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1428	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1429	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
938	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1430	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939	respectively.	1431	respectively.
940		1432
941	=head1 TEXT SELECTION AND INSERTION	1433	=head1 THE SELECTION: SELECTING AND PASTING TEXT
942		1434
943	The behaviour of text selection and insertion mechanism is similar to	1435	The behaviour of text selection and insertion/pasting mechanism is similar
944	I<xterm>(1).	1436	to I<xterm>(1).
945		1437
946	=over 4	1438	=over 4
947		1439
948	=item B<Selection>:	1440	=item B<Selecting>:
949		1441
950	Left click at the beginning of the region, drag to the end of the region	1442	Left click at the beginning of the region, drag to the end of the region
951	and release; Right click to extend the marked region; Left double-click	1443	and release; Right click to extend the marked region; Left double-click
952	to select a word; Left triple-click to select the entire logical line	1444	to select a word; Left triple-click to select the entire logical line
953	(which can span multiple screen lines), unless modified by resource	1445	(which can span multiple screen lines), unless modified by resource
954	B<tripleclickwords>.	1446	B<tripleclickwords>.
955		1447
956	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1448	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
957	(Compile: I<frills>) will create a rectangular selection instead of a normal	1449	(Compile: I<frills>) will create a rectangular selection instead of a
958	one.	1450	normal one. In this mode, every selected row becomes its own line in the
		1451	selection, and trailing whitespace is visually underlined and removed from
		1452	the selection.
959		1453
960	=item B<Insertion>:	1454	=item B<Pasting>:
961		1455
962	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1456	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
963	an B<@@RXVT_NAME@@> window causes the current text selection to be	1457	window causes the value of the PRIMARY selection (or CLIPBOARD with the
964	inserted as if it had been typed on the keyboard.	1458	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1459
		1460	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1461	inserted too.
		1462
		1463	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1464	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1465	binding causes the value of the internal selection to be copied to the
		1466	CLIPBOARD selection, while the second binding causes the value of the
		1467	CLIPBOARD selection to be inserted.
965		1468
966	=back	1469	=back
967		1470
968	=head1 CHANGING FONTS	1471	=head1 CHANGING FONTS
969		1472
970	Changing fonts (or font sizes, respectively) via the keypad is not yet	1473	Changing fonts (or font sizes, respectively) via the keypad is not yet
971	supported in rxvt-unicode. Bug me if you need this.	1474	supported in rxvt-unicode. Bug me if you need this.
972		1475
973	You can, however, switch fonts at runtime using escape sequences (and	1476	You can, however, switch fonts at runtime using escape sequences, e.g.:
974	therefore using the menubar), e.g.:
975		1477
976	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1478	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1479
		1480	You can use keyboard shortcuts, too:
		1481
		1482	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1483	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
977		1484
978	rxvt-unicode will automatically re-apply these fonts to the output so far.	1485	rxvt-unicode will automatically re-apply these fonts to the output so far.
979		1486
980	=head1 ISO 14755 SUPPORT	1487	=head1 ISO 14755 SUPPORT
981		1488
982	ISO 14755 is a standard for entering and viewing unicode characters	1489	ISO 14755 is a standard for entering and viewing unicode characters
983	and character codes using the keyboard. It consists of 4 parts. The	1490	and character codes using the keyboard. It consists of 4 parts. The
984	first part is available rxvt-unicode has been compiled with	1491	first part is available if rxvt-unicode has been compiled with
985	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1492	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
986	with C<--enable-iso14755>.	1493	with C<--enable-iso14755>.
987		1494
988	=over 4	1495	=over 4
989		1496
…		…
1009	This mode lets you input characters representing the keycap symbols of	1516	This mode lets you input characters representing the keycap symbols of
1010	your keyboard, if representable in the current locale encoding.	1517	your keyboard, if representable in the current locale encoding.
1011		1518
1012	Start by pressing C<Control> and C<Shift> together, then releasing	1519	Start by pressing C<Control> and C<Shift> together, then releasing
1013	them. The next special key (cursor keys, home etc.) you enter will not	1520	them. The next special key (cursor keys, home etc.) you enter will not
1014	invoke it's usual function but instead will insert the corresponding	1521	invoke its usual function but instead will insert the corresponding
1015	keycap symbol. The symbol will only be entered when the key has been	1522	keycap symbol. The symbol will only be entered when the key has been
1016	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1523	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1017	C<ISO Level 2 Switch>, although your intention might have been to enter a	1524	C<ISO Level 2 Switch>, although your intention might have been to enter a
1018	reverse tab (Shift-Tab).	1525	reverse tab (Shift-Tab).
1019		1526
…		…
1047	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1554	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1048	it can be seen via the I<who(1)> command, and can accept messages. To	1555	it can be seen via the I<who(1)> command, and can accept messages. To
1049	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1556	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1050	on some systems or setgid to root or to some other group on others.	1557	on some systems or setgid to root or to some other group on others.
1051		1558
1052	=head1 COLORS AND GRAPHICS	1559	=head1 COLOURS AND GRAPHICS
1053		1560
1054	In addition to the default foreground and background colours,	1561	In addition to the default foreground and background colours,
1055	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1562	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1056	high-intensity bold/blink versions of the same). Here is a list of the	1563	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1057	colours with their B<rgb.txt> names.	1564	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1565	cube plus a 8 (24) colour greyscale ramp.
		1566
		1567	Here is a list of the ANSI colours with their names.
1058		1568
1059	=begin table	1569	=begin table
1060		1570
1061	B<color0> (black) = Black	1571	B<color0> (black) = Black
1062	B<color1> (red) = Red3	1572	B<color1> (red) = Red3
…		…
1082	It is also possible to specify the colour values of B<foreground>,	1592	It is also possible to specify the colour values of B<foreground>,
1083	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1593	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1084	a number 0-15, as a convenient shorthand to reference the colour name of	1594	a number 0-15, as a convenient shorthand to reference the colour name of
1085	color0-color15.	1595	color0-color15.
1086		1596
		1597	The following text gives values for the standard 88 colour mode (and
		1598	values for the 256 colour mode in parentheses).
		1599
		1600	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1601
		1602	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1603	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1604
		1605	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1606	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1607	the RGB cube.
		1608
		1609	Together, all those colours implement the 88 (256) colour xterm
		1610	colours. Only the first 16 can be changed using resources currently, the
		1611	rest can only be changed via command sequences ("escape codes").
		1612
		1613	Applications are advised to use terminfo or command sequences to discover
		1614	number and RGB values of all colours (yes, you can query this...).
		1615
1087	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1616	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1088	always swapping the foreground/background colours. This is in contrast to	1617	always swapping the foreground/background colours. This is in contrast to
1089	I<xterm>(1) where the colours are only swapped if they have not otherwise	1618	I<xterm>(1) where the colours are only swapped if they have not otherwise
1090	been specified. For example,	1619	been specified. For example,
1091		1620
		1621	@@RXVT_NAME@@ -fg Black -bg White -rv
		1622
		1623	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1624	White.
		1625
		1626	=head2 ALPHA CHANNEL SUPPORT
		1627
		1628	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1629	their act together, rxvt-unicode will do its own alpha channel management:
		1630
		1631	You can prefix any colour with an opaqueness percentage enclosed in
		1632	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1633	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1634	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1635	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1636	is the recommended format to specify transparency values, and works with
		1637	all ways to specify a colour.
		1638
		1639	For complete control, rxvt-unicode also supports
		1640	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1641	specifications, where the additional C<aaaa> component specifies opacity
		1642	(alpha) values. The minimum value of C<0000> is completely transparent,
		1643	while C<ffff> is completely opaque). The two example colours from
		1644	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1645	C<rgba:0000/ff00/0000/f332>.
		1646
		1647	You probably need to specify B<"-depth 32">, too, to force a visual with
		1648	alpha channels, and have the luck that your X-server uses ARGB pixel
		1649	layout, as X is far from just supporting ARGB visuals out of the box, and
		1650	rxvt-unicode just fudges around.
		1651
		1652	For example, the following selects an almost completely transparent black
		1653	background, and an almost opaque pink foreground:
		1654
		1655	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1656
		1657	When not using a background image, then the interpretation of the
		1658	alpha channel is up to your compositing manager (most interpret it as
		1659	transparency of course).
		1660
		1661	When using a background pixmap or pseudo-transparency, then the background
		1662	colour will always behave as if it were completely transparent (so the
		1663	background image shows instead), regardless of how it was specified, while
		1664	other colours will either be transparent as specified (the background
		1665	image will show through) on servers supporting the RENDER extension, or
		1666	fully opaque on servers not supporting the RENDER EXTENSION.
		1667
		1668	Please note that due to bugs in Xft, specifying alpha values might result
		1669	in garbage being displayed when the X-server does not support the RENDER
		1670	extension.
		1671
		1672	=head1 ENVIRONMENT
		1673
		1674	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1675
1092	=over 4	1676	=over 4
1093		1677
1094	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1678	=item B<TERM>
1095		1679
1096	would yield White on Black, while on I<xterm>(1) it would yield Black	1680	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1097	on White.	1681	resources or on the command line.
		1682
		1683	=item B<COLORTERM>
		1684
		1685	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1686	compiled with background image support, and optionally with the added
		1687	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1688	screen.
		1689
		1690	=item B<COLORFGBG>
		1691
		1692	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1693	the colour code used as default foreground/text colour (or the string
		1694	C<default> to indicate that the default-colour escape sequence is to be
		1695	used), C<bg> is the colour code used as default background colour (or the
		1696	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1697	was compiled with background image support. Libraries like C<ncurses>
		1698	and C<slang> can (and do) use this information to optimize screen output.
		1699
		1700	=item B<WINDOWID>
		1701
		1702	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1703	window, which usually has subwindows for the scrollbar, the terminal
		1704	window and so on).
		1705
		1706	=item B<TERMINFO>
		1707
		1708	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1709	C<--with-terminfo=PATH>.
		1710
		1711	=item B<DISPLAY>
		1712
		1713	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1714	display in its child processes if C<-display> isn't used to override. It
		1715	defaults to C<:0> if it doesn't exist.
		1716
		1717	=item B<SHELL>
		1718
		1719	The shell to be used for command execution, defaults to C</bin/sh>.
		1720
		1721	=item B<RXVT_SOCKET> [I<sic>]
		1722
		1723	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1724	@@RXVT_NAME@@d(1).
		1725
		1726	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1727
		1728	=item B<URXVT_PERL_LIB>
		1729
		1730	Additional F<:>-separated library search path for perl extensions. Will be
		1731	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1732	directory.
		1733
		1734	=item B<URXVT_PERL_VERBOSITY>
		1735
		1736	See L<@@RXVT_NAME@@perl>(3).
		1737
		1738	=item B<HOME>
		1739
		1740	Used to locate the default directory for the unix domain socket for
		1741	daemon communications and to locate various resource files (such as
		1742	C<.Xdefaults>)
		1743
		1744	=item B<XAPPLRESDIR>
		1745
		1746	Directory where application-specific X resource files are located.
		1747
		1748	=item B<XENVIRONMENT>
		1749
		1750	If set and accessible, gives the name of a X resource file to be loaded by
		1751	@@RXVT_NAME@@.
1098		1752
1099	=back	1753	=back
1100		1754
1101	=head1 ENVIRONMENT
1102
1103	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1104	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1105	window id number of the B<@@RXVT_NAME@@> window and it also uses and
1106	sets the environment variable B<DISPLAY> to specify which display
1107	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1108	B<RXVTPATH> and B<PATH> to find XPM files.
1109
1110	=head1 FILES	1755	=head1 FILES
1111		1756
1112	=over 4	1757	=over 4
1113		1758
1114	=item B</usr/lib/X11/rgb.txt>	1759	=item B</usr/lib/X11/rgb.txt>
1115		1760
1116	Color names.	1761	Colour names.
1117		1762
1118	=back	1763	=back
1119		1764
1120	=head1 SEE ALSO	1765	=head1 SEE ALSO
1121		1766
		1767	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1122	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1768	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1123
1124	=head1 BUGS
1125
1126	Check the BUGS file for an up-to-date list.
1127
1128	Cursor change support is not yet implemented.
1129
1130	Click-and-drag doesn't work with X11 mouse report overriding.
1131		1769
1132	=head1 CURRENT PROJECT COORDINATOR	1770	=head1 CURRENT PROJECT COORDINATOR
1133		1771
1134	=over 4	1772	=over 4
1135		1773
1136	=item Project Coordinator	1774	=item Project Coordinator
1137		1775
1138	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1776	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1139		1777
1140	=item Web page maintainter	1778	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1141
1142	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144	L<@@RXVT_WEBPAGE@@>
1145		1779
1146	=back	1780	=back
1147		1781
1148	=head1 AUTHORS	1782	=head1 AUTHORS
1149		1783
…		…
1151		1785
1152	=item John Bovey	1786	=item John Bovey
1153		1787
1154	University of Kent, 1992, wrote the original Xvt.	1788	University of Kent, 1992, wrote the original Xvt.
1155		1789
1156	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1790	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1157		1791
1158	very heavily modified Xvt and came up with Rxvt	1792	very heavily modified Xvt and came up with Rxvt
1159		1793
1160	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1794	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1161		1795
1162	wrote the Greek Keyboard Input (no longer in code)	1796	wrote the Greek Keyboard Input (no longer in code)
1163		1797
1164	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1798	=item mj olesen <olesen@me.QueensU.CA>
1165		1799
1166	Wrote the menu system.	1800	Wrote the menu system.
1167		1801
1168	Project Coordinator (changes.txt 2.11 to 2.21)	1802	Project Coordinator (changes.txt 2.11 to 2.21)
1169		1803
1170	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1804	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1171		1805
1172	Project Coordinator (changes.txt 2.21a to 2.4.5)	1806	Project Coordinator (changes.txt 2.21a to 2.4.5)
1173		1807
1174	=item Geoff Wing L<< <gcw@pobox.com> >>	1808	=item Geoff Wing <gcw@pobox.com>
1175		1809
1176	Rewrote screen display and text selection routines. Project Coordinator	1810	Rewrote screen display and text selection routines.
		1811
1177	(changes.txt 2.4.6 - rxvt-unicode)	1812	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1178		1813
1179	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1814	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1180		1815
1181	Forked rxvt-unicode, rewrote most of the display code and internal	1816	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1182	character handling to store text in unicode, improve xterm	1817	extension, random hacks, numerous bugfixes and extensions.
1183	compatibility and apply numerous other bugfixes and extensions.
1184		1818
1185	Project Coordinator (Changes 1.0 -)	1819	Project Coordinator (Changes 1.0 -)
1186		1820
		1821	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
		1822
		1823	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1824
1187	=back	1825	=back
1188		1826

Diff Legend

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