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

Diff Legend

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