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.108 by root, Sun Jan 29 21:45:47 2006 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

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

Diff Legend

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