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.30 by root, Wed Sep 8 17:10:23 2004 UTC vs.
Revision 1.240 by sf-exg, Mon Oct 13 17:05:32 2014 UTC

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

Diff Legend

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