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

Diff Legend

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