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.107 by root, Sun Jan 29 20:51:27 2006 UTC vs.
Revision 1.242 by sf-exg, Fri Dec 26 21:49:11 2014 UTC

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

Diff Legend

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