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.5 by root, Sat Aug 14 03:00:32 2004 UTC vs.
Revision 1.132 by root, Mon Jun 18 13:38:12 2007 UTC

…		…
11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal	11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
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
		17	=head1 FREQUENTLY ASKED QUESTIONS
		18
		19	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
		21	problems. That document is also accessible on the World-Wide-Web at
		22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
16		23
17	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
18		25
19	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
20	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
21	world. Being a terminal emulator, however, some things are very difficult,	28	world. Being a terminal emulator, however, some things are very difficult,
22	especially cursive scripts such as arabic, vertically written scripts	29	especially cursive scripts such as arabic, vertically written scripts
23	like mongolian or scripts requiring extremely complex combining rules,	30	like mongolian or scripts requiring extremely complex combining rules,
24	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devenagari. Don't expect pretty output when using these
25	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26	fine, though. A somewhat difficult case are left-to-right scripts, such	33	fine, though. A somewhat difficult case are right-to-left scripts, such
27	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
29	such as cursor-movement -- break othwerwise).	36	such as cursor-movement while editing -- break otherwise), but that might
		37	change.
30		38
		39	If you are looking for a terminal that supports more exotic scripts, let
		40	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
		42	because the author couldn't get C<mlterm> to use one font for latin1 and
		43	another for japanese.
		44
31	Another design rationale was the use of multiple fonts to display	45	Therefore another design rationale was the use of multiple fonts to
32	characters: The idea of a single unicode font which many other programs	46	display characters: The idea of a single unicode font which many other
33	force onto it's users never made sense to me: You should be able to choose	47	programs force onto its users never made sense to me: You should be able
34	any font for any script.	48	to choose any font for any script freely.
35		49
36	Apart from that, rxvt-unicode is also much better internationalised than	50	Apart from that, rxvt-unicode is also much better internationalised than
37	it's predecessor, supports things such as XFT and ISO 14755 that are handy	51	its predecessor, supports things such as XFT and ISO 14755 that are handy
38	in i18n-environments, is faster, and has a lot less bugs than the original	52	in i18n-environments, is faster, and has a lot bugs less than the original
39	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
40		54
41	It is still faithfully following the original rxvt idea of being lean	55	It is still faithfully following the original rxvt idea of being lean
42	and nice on resources: for example, you can still configure rxvt-unicode	56	and nice on resources: for example, you can still configure rxvt-unicode
43	without most of it's features to get a lean binary. It also comes with	57	without most of its features to get a lean binary. It also comes with
44	a client/daemon pair that lets you open any number of terminal windows	58	a client/daemon pair that lets you open any number of terminal windows
45	from within a single process, which makes startup time very fast and	59	from within a single process, which makes startup time very fast and
46	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
47	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
48		62
49	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
50	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
51	reference documentation (escape sequences etc.) and the FAQ section at the	65	reference documentation (escape sequences etc.).
52	end of this document.
53		66
54	=head1 OPTIONS	67	=head1 OPTIONS
55		68
56	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
57	below. In keeping with the smaller-is-better philosophy, options may be	70	below. In keeping with the smaller-is-better philosophy, options may be
…		…
80		93
81	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
82	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
83	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
84		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<xft>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
85	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
86		104
87	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
88		106
89	=item B<-rv>|B<+rv>	107	=item B<-rv>|B<+rv>
90		108
91	Turn on/off simulated reverse video; resource B<reverseVideo>.	109	Turn on/off simulated reverse video; resource B<reverseVideo>.
92		110
93	=item B<-j>|B<+j>	111	=item B<-j>|B<+j>
94		112
95	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
96		114
97	=item B<-ip>|B<+ip>	115	=item B<-ss>|B<+ss>
		116
		117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
		118
		119	=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
98		120
99	Turn on/off inheriting parent window's pixmap. Alternative form is	121	Turn on/off inheriting parent window's pixmap. Alternative form is
100	B<-tr>; resource B<inheritPixmap>.	122	B<-tr>; resource B<inheritPixmap>.
101		123
		124	I<Please note that transparency of any kind if completely unsupported by
		125	the author. Don't bug him with installation questions! Read the FAQ (man 7
		126	@@RXVT_NAME@@)!>
		127
102	=item B<-fade> I<number>	128	=item B<-fade> I<number>
103		129
104	Fade the text by the given percentage when focus is lost.	130	Fade the text by the given percentage when focus is lost. Small values
		131	fade a little only, 100 completely replaces all colours by the fade
		132	colour; resource B<fading>.
		133
		134	=item B<-fadecolor> I<colour>
		135
		136	Fade to this colour when fading is used (see B<-fade>). The default colour
		137	is opaque black. resource B<fadeColor>.
105		138
106	=item B<-tint> I<colour>	139	=item B<-tint> I<colour>
107		140
108	Tint the transparent background pixmap with the given colour when	141	Tint the transparent background pixmap with the given colour when
109	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	142	transparency is enabled with B<-tr> or B<-ip>. This only works for
110	option that can be used to brighten or darken the image in addition to	143	non-tiled backgrounds, currently. See also the B<-sh> option that can be
111	tinting it.	144	used to brighten or darken the image in addition to tinting it; resource
		145	I<tintColor>. Example:
112		146
113	=item B<-sh>	147	@@RXVT_NAME@@ -tr -tint blue -sh 40
114		148
		149	=item B<-sh> I<number>
		150
115	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	151	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
116	background image in addition to tinting it (i.e. B<-tint> must be	152	background image in addition to (or instead of) tinting it;
117	specified, too).	153	resource I<shading>.
		154
		155	=item B<-blt> I<string>
		156
		157	Specify background blending type. If background pixmap is specified
		158	at the same time as transparency - such pixmap will be blended over
		159	transparency image, using method specified. Supported values are :
		160	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		163	alpha-blending; resource I<blendType>.
		164
		165	=item B<-blr> I<number>
		166
		167	Apply Gaussian Blur with the specified radius to the transparent
		168	background image; resource I<blurRadius>.
118		169
119	=item B<-bg> I<colour>	170	=item B<-bg> I<colour>
120		171
121	Window background colour; resource B<background>.	172	Window background colour; resource B<background>.
122		173
…		…
124		175
125	Window foreground colour; resource B<foreground>.	176	Window foreground colour; resource B<foreground>.
126		177
127	=item B<-pixmap> I<file[;geom]>	178	=item B<-pixmap> I<file[;geom]>
128		179
129	Compile I<XPM>: Specify XPM file for the background and also optionally	180	Compile I<afterimage>: Specify image file for the background and also
130	specify its scaling with a geometry string. Note you may need to add	181	optionally specify its scaling with a geometry string. Note you may need to
131	quotes to avoid special shell interpretation of the `;' in the	182	add quotes to avoid special shell interpretation of the C<;> in the
132	command-line; resource B<backgroundPixmap>.	183	command-line; for more details see resource B<backgroundPixmap>.
133		184
134	=item B<-cr> I<colour>	185	=item B<-cr> I<colour>
135		186
136	The cursor colour; resource B<cursorColor>.	187	The cursor colour; resource B<cursorColor>.
137		188
…		…
143		194
144	The mouse pointer background colour; resource B<pointerColor2>.	195	The mouse pointer background colour; resource B<pointerColor2>.
145		196
146	=item B<-bd> I<colour>	197	=item B<-bd> I<colour>
147		198
148	The colour of the border between the xterm scrollbar and the text;	199	The colour of the border around the text area and between the scrollbar and the text;
149	resource B<borderColor>.	200	resource B<borderColor>.
150		201
151	=item B<-fn> I<fontname>	202	=item B<-fn> I<fontlist>
152		203
153	Select the fonts to be used. This is a comma seperated list of font	204	Select the fonts to be used. This is a comma separated list of font names
154	names that are used in turn when trying to display Unicode characters.	205	that are checked in order when trying to find glyphs for characters. The
155	The first font defines the cell size for characters; other fonts might	206	first font defines the cell size for characters; other fonts might be
156	be smaller, but not larger. A reasonable default font list is always	207	smaller, but not (in general) larger. A (hopefully) reasonable default
157	appended to it. resource B<font>.	208	font list is always appended to it. See resource B<font> for more details.
		209
		210	In short, to specify an X11 core font, just specify its name or prefix it
		211	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		212	e.g.:
		213
		214	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		215	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
158		216
159	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	217	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
160	section.	218	section of @@RXVT_NAME@@(7).
161		219
		220	=item B<-fb> I<fontlist>
		221
		222	Compile I<font-styles>: The bold font list to use when B<bold> characters
		223	are to be printed. See resource B<boldFont> for details.
		224
		225	=item B<-fi> I<fontlist>
		226
		227	Compile I<font-styles>: The italic font list to use when I<italic>
		228	characters are to be printed. See resource B<italicFont> for details.
		229
		230	=item B<-fbi> I<fontlist>
		231
		232	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
		233	italic> >> characters are to be printed. See resource B<boldItalicFont>
		234	for details.
		235
162	=item B<-rb>|B<+rb>	236	=item B<-is>|B<+is>
163		237
164	Enable "real bold" support. When this option is on, bold text will be	238	Compile I<font-styles>: Bold/Italic font styles imply high intensity
165	displayed using the first available bold font in the font list. Bold	239	foreground/background (default). See resource B<intensityStyles> for
166	fonts should thus be specified in the font list after their	240	details.
167	corresponding regular fonts. If no bold font can be found, a regular
168	font will be used. resource B<realBold>.
169		241
170	=item B<-name> I<name>	242	=item B<-name> I<name>
171		243
172	Specify the application name under which resources are to be obtained,	244	Specify the application name under which resources are to be obtained,
173	rather than the default executable file name. Name should not contain	245	rather than the default executable file name. Name should not contain
…		…
211		283
212	Put scrollbar on right/left; resource B<scrollBar_right>.	284	Put scrollbar on right/left; resource B<scrollBar_right>.
213		285
214	=item B<-st>|B<+st>	286	=item B<-st>|B<+st>
215		287
216	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	288	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
217	resource B<scrollBar_floating>.	289	resource B<scrollBar_floating>.
		290
		291	=item B<-ptab>|B<+ptab>
		292
		293	If enabled (default), "Horizontal Tab" characters are being stored as
		294	actual wide characters in the screen buffer, which makes it possible to
		295	select and paste them. Since a horizontal tab is a cursor movement and
		296	not an actual glyph, this can sometimes be visually annoying as the cursor
		297	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
218		298
219	=item B<-bc>|B<+bc>	299	=item B<-bc>|B<+bc>
220		300
221	Blink the cursor; resource B<cursorBlink>.	301	Blink the cursor; resource B<cursorBlink>.
222		302
…		…
245		325
246	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	326	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
247	if honoured by the WM, the rxvt-unicode window will not have window	327	if honoured by the WM, the rxvt-unicode window will not have window
248	decorations; resource B<borderLess>.	328	decorations; resource B<borderLess>.
249		329
		330	=item B<-override-redirect>
		331
		332	Compile I<frills>: Sets override-redirect on the window; resource
		333	B<override-redirect>.
		334
		335	=item B<-sbg>
		336
		337	Compile I<frills>: Disable the usage of the built-in block graphics/line
		338	drawing characters and just rely on what the specified fonts provide. Use
		339	this if you have a good font and want to use its block graphic glyphs;
		340	resource B<skipBuiltinGlyphs>.
		341
250	=item B<-lsp> I<number>	342	=item B<-lsp> I<number>
251		343
252	Compile I<linespace>: Lines (pixel height) to insert between each row	344	Compile I<frills>: Lines (pixel height) to insert between each row of
253	of the display; resource B<linespace>.	345	the display. Useful to work around font rendering problems; resource
		346	B<linespace>.
254		347
255	=item B<-tn> I<termname>	348	=item B<-tn> I<termname>
256		349
257	This option specifies the name of the terminal type to be set in the	350	This option specifies the name of the terminal type to be set in the
258	B<TERM> environment variable. This terminal type must exist in the	351	B<TERM> environment variable. This terminal type must exist in the
…		…
267	given on the command line. If this option is used, it must be the last	360	given on the command line. If this option is used, it must be the last
268	on the command-line. If there is no B<-e> option then the default is to	361	on the command-line. If there is no B<-e> option then the default is to
269	run the program specified by the B<SHELL> environment variable or,	362	run the program specified by the B<SHELL> environment variable or,
270	failing that, I<sh(1)>.	363	failing that, I<sh(1)>.
271		364
		365	Please note that you must specify a program with arguments. If you want to
		366	run shell commands, you have to specify the shell, like this:
		367
		368	@@RXVT_NAME@@ -e sh -c "shell commands"
		369
272	=item B<-title> I<text>	370	=item B<-title> I<text>
273		371
274	Window title (B<-T> still respected); the default title is the basename	372	Window title (B<-T> still respected); the default title is the basename
275	of the program specified after the B<-e> option, if any, otherwise the	373	of the program specified after the B<-e> option, if any, otherwise the
276	application name; resource B<title>.	374	application name; resource B<title>.
…		…
294		392
295	Compile I<XIM>: input method name. resource B<inputMethod>.	393	Compile I<XIM>: input method name. resource B<inputMethod>.
296		394
297	=item B<-imlocale> I<string>	395	=item B<-imlocale> I<string>
298		396
299	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	397	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
300	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	398	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
301	extension to be able to input japanese characters while staying in	399	input extension to be able to input japanese characters while staying in
302	another locale.	400	another locale. resource B<imLocale>.
		401
		402	=item B<-imfont> I<fontset>
		403
		404	Set the font set to use for the X Input Method, see resource B<imFont>
		405	for more info.
		406
		407	=item B<-tcw>
		408
		409	Change the meaning of triple-click selection with the left mouse
		410	button. Only effective when the original (non-perl) selection code is
		411	in-use. Instead of selecting a full line it will extend the selection the
		412	end of the logical line only. resource B<tripleclickwords>.
303		413
304	=item B<-insecure>	414	=item B<-insecure>
305		415
306	Enable "insecure" mode, which currently enables most of the escape	416	Enable "insecure" mode, which currently enables most of the escape
307	sequences that echo strings. See the resource B<insecure> for more	417	sequences that echo strings. See the resource B<insecure> for more
…		…
321	=item B<-ssr>|B<+ssr>	431	=item B<-ssr>|B<+ssr>
322		432
323	Turn on/off secondary screen scroll (default enabled); resource	433	Turn on/off secondary screen scroll (default enabled); resource
324	B<secondaryScroll>.	434	B<secondaryScroll>.
325		435
		436	=item B<-hold>|B<+hold>
		437
		438	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		439	will not immediately destroy its window when the program executed within
		440	it exits. Instead, it will wait till it is being killed or closed by the
		441	user; resource B<hold>.
		442
		443	=item B<-keysym.>I<sym> I<string>
		444
		445	Remap a key symbol. See resource B<keysym>.
		446
		447	=item B<-embed> I<windowid>
		448
		449	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		450	which enables applications to easily embed a terminal.
		451
		452	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		453	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		454	quite a bit, so don't expect it to keep some specific state. It's best to
		455	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		456
		457	The window will not be destroyed when @@RXVT_NAME@@ exits.
		458
		459	It might be useful to know that @@RXVT_NAME@@ will not close file
		460	descriptors passed to it (except for stdin/out/err, of course), so you
		461	can use file descriptors to communicate with the programs within the
		462	terminal. This works regardless of whether the C<-embed> option was used or
		463	not.
		464
		465	Here is a short Gtk2-perl snippet that illustrates how this option can be
		466	used (a longer example is in F<doc/embed>):
		467
		468	my $rxvt = new Gtk2::Socket;
		469	$rxvt->signal_connect_after (realize => sub {
		470	my $xid = $_[0]->window->get_xid;
		471	system "@@RXVT_NAME@@ -embed $xid &";
		472	});
		473
		474	=item B<-pty-fd> I<file descriptor>
		475
		476	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		477	pair but instead use the given file descriptor as the tty master. This is
		478	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		479	without having to run a program within it.
		480
		481	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		482	entries and will not tinker with pty/tty permissions - you have to do that
		483	yourself if you want that.
		484
		485	As an extremely special case, specifying C<-1> will completely suppress
		486	pty/tty operations.
		487
		488	Here is a example in perl that illustrates how this option can be used (a
		489	longer example is in F<doc/pty-fd>):
		490
		491	use IO::Pty;
		492	use Fcntl;
		493
		494	my $pty = new IO::Pty;
		495	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		496	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		497	close $pty;
		498
		499	# now communicate with rxvt
		500	my $slave = $pty->slave;
		501	while (<$slave>) { print $slave "got <$_>\n" }
		502
326	=item B<-xrm> I<resourcestring>	503	=item B<-pe> I<string>
327		504
328	No effect on rxvt-unicode. Simply passes through an argument to be made	505	Comma-separated list of perl extension scripts to use (or not to use) in
329	available in the instance's argument list. Appears in I<WM_COMMAND> in	506	this terminal instance. See resource B<perl-ext> for details.
330	some window managers.
331		507
332	=back	508	=back
333		509
334	=head1 RESOURCES (available also as long-options)	510	=head1 RESOURCES (available also as long-options)
335		511
336	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	512	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
337	options) compiled into your version.	513	options) compiled into your version.
338		514
339	There are two different methods that @@RXVT_NAME@@ can use to get the	515	You can set and change the resources using X11 tools like B<xrdb>. Many
340	Xresource data: using the X libraries (Xrm*-functions) or internal	516	distribution do also load settings from the B<~/.Xresources> file when X
341	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	517	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
342	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	518	with later settings overwriting earlier ones:
343	resources using X11 tools like B<xset>. Many distribution do also load
344	settings from the B<~/.Xresources> file when X starts.
345		519
346	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	520	1. system-wide app-defaults file, either locale-dependent OR global
347	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	521	2. app-defaults file in $XAPPLRESDIR
348	set in XAPPLOADDIR/URxvt (compile-time defined: usually	522	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
349	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	523	4. SCREEN_RESOURCES for the current screen
350	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	524	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		525
351	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	526	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
352	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	527	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
353	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	528	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
354	easily configured, while the class name B<URxvt> allows resources	529	configured, while the class name B<URxvt> allows resources unique to
355	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	530	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
356	shared between different B<@@RXVT_NAME@@> configurations. If no	531	configurations. If no resources are specified, suitable defaults will
357	resources are specified, suitable defaults will be used. Command-line	532	be used. Command-line arguments can be used to override resource
358	arguments can be used to override resource settings. The following	533	settings. The following resources are supported (you might want to
359	resources are allowed:	534	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		535	extensions not documented here):
360		536
361	=over 4	537	=over 4
		538
		539	=item B<depth:> I<bitdepth>
		540
		541	Compile I<xft>: Attempt to find a visual with the given bit depth;
		542	option B<-depth>.
362		543
363	=item B<geometry:> I<geom>	544	=item B<geometry:> I<geom>
364		545
365	Create the window with the specified X window geometry [default 80x24];	546	Create the window with the specified X window geometry [default 80x24];
366	option B<-geometry>.	547	option B<-geometry>.
…		…
382	high-intensity (bold = bright foreground, blink = bright background)	563	high-intensity (bold = bright foreground, blink = bright background)
383	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	564	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
384	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	565	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
385	names used are listed in the B<COLORS AND GRAPHICS> section.	566	names used are listed in the B<COLORS AND GRAPHICS> section.
386		567
		568	Colours higher than 15 cannot be set using resources (yet), but can be
		569	changed using an escape command (see @@RXVT_NAME@@(7)).
		570
		571	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		572	88 colour support). Colours 80-87 are evenly spaces grey steps.
		573
387	=item B<colorBD:> I<colour>	574	=item B<colorBD:> I<colour>
388		575
		576	=item B<colorIT:> I<colour>
		577
389	Use the specified colour to display bold characters when the foreground	578	Use the specified colour to display bold or italic characters when the
390	colour is the default. This option will be ignored if B<realBold> is	579	foreground colour is the default. If font styles are not available
391	enabled.	580	(Compile I<styles>) and this option is unset, reverse video is used instead.
392		581
393	=item B<colorUL:> I<colour>	582	=item B<colorUL:> I<colour>
394		583
395	Use the specified colour to display underlined characters when the	584	Use the specified colour to display underlined characters when the
396	foreground colour is the default.	585	foreground colour is the default.
397		586
398	=item B<colorRV:> I<colour>	587	=item B<colorRV:> I<colour>
399		588
400	Use the specified colour as the background for reverse video	589	Use the specified colour as the background for reverse video characters
401	characters.	590	when OPTION_HC is disabled (--disable-frills).
		591
		592	=item B<underlineColor:> I<colour>
		593
		594	If set, use the specified colour as the colour for the underline
		595	itself. If unset, use the foreground colour.
402		596
403	=item B<cursorColor:> I<colour>	597	=item B<cursorColor:> I<colour>
404		598
405	Use the specified colour for the cursor. The default is to use the	599	Use the specified colour for the cursor. The default is to use the
406	foreground colour; option B<-cr>.	600	foreground colour; option B<-cr>.
…		…
417	option B<-rv>. B<False>: regular screen colours [default]; option	611	option B<-rv>. B<False>: regular screen colours [default]; option
418	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	612	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
419		613
420	=item B<jumpScroll:> I<boolean>	614	=item B<jumpScroll:> I<boolean>
421		615
422	B<True>: specify that jump scrolling should be used. When scrolling	616	B<True>: specify that jump scrolling should be used. When receiving lots
423	quickly, fewer screen updates are performed [default]; option B<-j>.	617	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		618	has been read, resulting in fewer updates while still displaying every
		619	received line; option B<-j>.
		620
424	B<False>: specify that smooth scrolling should be used; option B<+j>.	621	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		622	force a screen refresh on each new line it received; option B<+j>.
		623
		624	=item B<skipScroll:> I<boolean>
		625
		626	B<True>: (the default) specify that skip scrolling should be used. When
		627	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
		628	(around 60 times per second), resulting in far fewer updates. This can
		629	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		630	option B<-ss>.
		631
		632	B<False>: specify that everything is to be displayed, even
		633	if the refresh is too fast for the human eye to read anything (or the
		634	monitor to display anything); option B<+ss>.
425		635
426	=item B<inheritPixmap:> I<boolean>	636	=item B<inheritPixmap:> I<boolean>
427		637
428	B<True>: make the background inherit the parent windows' pixmap, giving	638	B<True>: make the background inherit the parent windows' pixmap, giving
429	artificial transparency. B<False>: do not inherit the parent windows'	639	artificial transparency. B<False>: do not inherit the parent windows'
430	pixmap.	640	pixmap.
431		641
		642	I<Please note that transparency of any kind if completely unsupported by
		643	the author. Don't bug him with installation questions!>
		644
432	=item B<fading:> I<number>	645	=item B<fading:> I<number>
433		646
434	Fade the text by the given percentage when focus is lost.	647	Fade the text by the given percentage when focus is lost; option B<-fade>.
		648
		649	=item B<fadeColor:> I<colour>
		650
		651	Fade to this colour, when fading is used (see B<fading:>). The default
		652	colour is black; option B<-fadecolor>.
435		653
436	=item B<tintColor:> I<colour>	654	=item B<tintColor:> I<colour>
437		655
438	Tint the transparent background pixmap with the given colour.	656	Tint the transparent background pixmap with the given colour; option
		657	B<-tint>.
439		658
440	=item B<shading:> I<number>	659	=item B<shading:> I<number>
441		660
442	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	661	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
443	image in addition to tinting it.	662	in addition to tinting it; option B<-sh>.
444		663
		664	=item B<blendType:> I<string>
		665
		666	Specify background blending type; option B<-blt>.
		667
445	=item B<fading:> I<number>	668	=item B<blurRadius:> I<number>
446		669
447	Scale the tint colour by the given percentage.	670	Apply Gaussian Blurr with the specified radius to the transparent
		671	background image; option B<-blr>.
448		672
449	=item B<scrollColor:> I<colour>	673	=item B<scrollColor:> I<colour>
450		674
451	Use the specified colour for the scrollbar [default #B2B2B2].	675	Use the specified colour for the scrollbar [default #B2B2B2].
452		676
453	=item B<troughColor:> I<colour>	677	=item B<troughColor:> I<colour>
454		678
455	Use the specified colour for the scrollbar's trough area [default	679	Use the specified colour for the scrollbar's trough area [default
456	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	680	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
		681
		682	=item B<borderColor:> I<colour>
		683
		684	The colour of the border around the text area and between the scrollbar
		685	and the text.
457		686
458	=item B<backgroundPixmap:> I<file[;geom]>	687	=item B<backgroundPixmap:> I<file[;geom]>
459		688
460	Use the specified XPM file (note the `.xpm' extension is optional) for	689	Use the specified image file for the background and also optionally
461	the background and also optionally specify its scaling with a geometry	690	specify its scaling with a geometry string B<WxH+X+Y>,
462	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	691	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
463	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	692	and B<"X" / "Y"> locate the image centre (percent).
464	centre (percent). A scale of 0 displays the image with tiling. A scale	693	A scale of 0 displays the image with tiling. A scale of 1 displays the
465	of 1 displays the image without any scaling. A scale of 2 to 9	694	image without any scaling. A scale of 2 to 9 specifies an integer
466	specifies an integer number of images in that direction. No image will	695	number of images in that direction. No image will be magnified beyond
467	be magnified beyond 10 times its original size. The maximum permitted	696	10 times its original size. The maximum permitted scale is 1000.
468	scale is 1000. [default 0x0+50+50]	697	Special string of B<"auto"> used as a geometry will cause image to be
469		698	automatically scaled to match window size.
470	=item B<menu:> I<file[;tag]>	699	If used in conjunction with B<-tr> option - specified pixmap will be
471		700	blended over transparency image using either alpha-blending, or any
472	Read in the specified menu file (note the `.menu' extension is	701	other blending type, specified with B<-blt "type"> option.
473	optional) and also optionally specify a starting tag to find. See the	702	[default 0x0+50+50]
474	reference documentation for details on the syntax for the menuBar.
475		703
476	=item B<path:> I<path>	704	=item B<path:> I<path>
477		705
478	Specify the colon-delimited search path for finding files (XPM and	706	Specify the colon-delimited search path for finding XPM files.
479	menus), in addition to the paths specified by the B<RXVTPATH> and
480	B<PATH> environment variables.
481		707
482	=item B<font:> I<fontname>	708	=item B<font:> I<fontlist>
483		709
484	Select the fonts to be used. This is a comma seperated list of font	710	Select the fonts to be used. This is a comma separated list of font names
485	names that are used in turn when trying to display Unicode characters.	711	that are checked in order when trying to find glyphs for characters. The
486	The first font defines the cell size for characters; other fonts might	712	first font defines the cell size for characters; other fonts might be
487	be smaller, but not larger. A reasonable default font list is always	713	smaller, but not (in general) larger. A (hopefully) reasonable default
488	appended to it. option B<-fn>.	714	font list is always appended to it; option B<-fn>.
489		715
490	=item B<realBold:> I<boolean>	716	Each font can either be a standard X11 core font (XLFD) name, with
		717	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
491		718
492	B<True>: Enable "real bold" support. When this option is on, bold text	719	In addition, each font can be prefixed with additional hints and
493	will be displayed using the first available bold font in the font list.	720	specifications enclosed in square brackets (C<[]>). The only available
494	Bold fonts should thus be specified in the font list after their	721	hint currently is C<codeset=codeset-name>, and this is only used for Xft
495	corresponding regular fonts. If no bold font can be found, a regular	722	fonts.
496	font will be used. option B<-rb>. B<False>: Display bold text in a	723
497	regular font, using the color specified with B<colorBD>; option B<+rb>.	724	For example, this font resource
		725
		726	URxvt.font: 9x15bold,\
		727	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		728	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		729	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		730	xft:Code2000:antialias=false
		731
		732	specifies five fonts to be used. The first one is C<9x15bold> (actually
		733	the iso8859-1 version of the second font), which is the base font (because
		734	it is named first) and thus defines the character cell grid to be 9 pixels
		735	wide and 15 pixels high.
		736
		737	The second font is just used to add additional unicode characters not in
		738	the base font, likewise the third, which is unfortunately non-bold, but
		739	the bold version of the font does contain less characters, so this is a
		740	useful supplement.
		741
		742	The third font is an Xft font with aliasing turned off, and the characters
		743	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		744	contains other characters, but we are not interested in them.
		745
		746	The last font is a useful catch-all font that supplies most of the
		747	remaining unicode characters.
		748
		749	=item B<boldFont:> I<fontlist>
		750
		751	=item B<italicFont:> I<fontlist>
		752
		753	=item B<boldItalicFont:> I<fontlist>
		754
		755	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		756	italic> >> characters, respectively.
		757
		758	If specified and non-empty, then the syntax is the same as for the
		759	B<font>-resource, and the given font list will be used as is, which makes
		760	it possible to substitute completely different font styles for bold and
		761	italic.
		762
		763	If unset (the default), a suitable font list will be synthesized by
		764	"morphing" the normal text font list into the desired shape. If that is
		765	not possible, replacement fonts of the desired shape will be tried.
		766
		767	If set, but empty, then this specific style is disabled and the normal
		768	text font will being used for the given style.
		769
		770	=item B<intensityStyles:> I<boolean>
		771
		772	When font styles are not enabled, or this option is enabled (B<True>,
		773	option B<-is>, the default), bold and italic font styles imply high
		774	intensity foreground/background colours. Disabling this option (B<False>,
		775	option B<+is>) disables this behaviour, the high intensity colours are not
		776	reachable.
498		777
499	=item B<selectstyle:> I<mode>	778	=item B<selectstyle:> I<mode>
500		779
501	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	780	Set mouse selection style to B<old> which is 2.20, B<oldword> which
502	xterm style with 2.20 old word selection, or anything else which gives	781	is xterm style with 2.20 old word selection, or anything else which
503	xterm style selection.	782	gives xterm style selection. Only effective when the original (non-perl)
		783	selection code is in use.
504		784
505	=item B<scrollstyle:> I<mode>	785	=item B<scrollstyle:> I<mode>
506		786
507	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	787	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
508	the author's favourite..	788	the author's favourite.
509		789
510	=item B<title:> I<string>	790	=item B<title:> I<string>
511		791
512	Set window title string, the default title is the command-line	792	Set window title string, the default title is the command-line
513	specified after the B<-e> option, if any, otherwise the application	793	specified after the B<-e> option, if any, otherwise the application
…		…
522	=item B<mapAlert:> I<boolean>	802	=item B<mapAlert:> I<boolean>
523		803
524	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	804	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
525	de-iconify (map) on receipt of a bell character [default].	805	de-iconify (map) on receipt of a bell character [default].
526		806
		807	=item B<urgentOnBell:> I<boolean>
		808
		809	B<True>: set the urgency hint for the wm on receipt of a bell character.
		810	B<False>: do not set the urgency hint [default].
		811
527	=item B<visualBell:> I<boolean>	812	=item B<visualBell:> I<boolean>
528		813
529	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	814	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
530	B<False>: no visual bell [default]; option B<+vb>.	815	B<False>: no visual bell [default]; option B<+vb>.
531		816
…		…
545		830
546	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	831	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
547	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	832	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
548	B<Shift-Print> to include the scrollback as well.	833	B<Shift-Print> to include the scrollback as well.
549		834
		835	The string will be interpreted as if typed into the shell as-is.
		836
		837	Example:
		838
		839	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		840
		841	This creates a new file in your home directory with the screen contents
		842	every time you hit C<Print>.
		843
550	=item B<scrollBar:> I<boolean>	844	=item B<scrollBar:> I<boolean>
551		845
552	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	846	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
553	disable the scrollbar; option B<+sb>.	847	disable the scrollbar; option B<+sb>.
554		848
…		…
573	B<False>: do not scroll to bottom when tty receives output; option	867	B<False>: do not scroll to bottom when tty receives output; option
574	B<+si>.	868	B<+si>.
575		869
576	=item B<scrollWithBuffer:> I<boolean>	870	=item B<scrollWithBuffer:> I<boolean>
577		871
578	B<True>: scroll with scrollback buffer when tty recieves new lines (and	872	B<True>: scroll with scrollback buffer when tty receives new lines (and
579	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	873	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
580	with scrollback buffer when tty recieves new lines; option B<-sw>.	874	with scrollback buffer when tty receives new lines; option B<+sw>.
581		875
582	=item B<scrollTtyKeypress:> I<boolean>	876	=item B<scrollTtyKeypress:> I<boolean>
583		877
584	B<True>: scroll to bottom when a non-special key is pressed. Special keys	878	B<True>: scroll to bottom when a non-special key is pressed. Special keys
585	are those which are intercepted by rxvt-unicode for special handling and	879	are those which are intercepted by rxvt-unicode for special handling and
586	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	880	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
587	bottom when a non-special key is pressed; option B<+sk>.	881	bottom when a non-special key is pressed; option B<+sk>.
588		882
589	=item B<smallfont_key:> I<keysym>
590
591	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
592	[default B<@@HOTKEY@@-@@SMALLFONT@@>]
593
594	=item B<bigfont_key:> I<keysym>
595
596	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
597	[default B<@@HOTKEY@@-@@BIGFONT@@>]
598
599	=item B<saveLines:> I<number>	883	=item B<saveLines:> I<number>
600		884
601	Save I<number> lines in the scrollback buffer [default 64]. This	885	Save I<number> lines in the scrollback buffer [default 64]. This
602	resource is limited on most machines to 65535; option B<-sl>.	886	resource is limited on most machines to 65535; option B<-sl>.
603		887
…		…
614	=item B<borderLess:> I<boolean>	898	=item B<borderLess:> I<boolean>
615		899
616	Set MWM hints to request a borderless window, i.e. if honoured by the	900	Set MWM hints to request a borderless window, i.e. if honoured by the
617	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	901	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
618		902
		903	=item B<skipBuiltinGlyphs:> I<boolean>
		904
		905	Compile I<frills>: Disable the usage of the built-in block graphics/line
		906	drawing characters and just rely on what the specified fonts provide. Use
		907	this if you have a good font and want to use its block graphic glyphs;
		908	option B<-sbg>.
		909
619	=item B<termName:> I<termname>	910	=item B<termName:> I<termname>
620		911
621	Specifies the terminal type name to be set in the B<TERM> environment	912	Specifies the terminal type name to be set in the B<TERM> environment
622	variable; option B<-tn>.	913	variable; option B<-tn>.
623		914
…		…
633		924
634	=item B<mouseWheelScrollPage:> I<boolean>	925	=item B<mouseWheelScrollPage:> I<boolean>
635		926
636	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	927	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
637	scrolls five lines [default].	928	scrolls five lines [default].
		929
		930	=item B<pastableTabs:> I<boolean>
		931
		932	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		933	movement only; option C<-ptab>.
638		934
639	=item B<cursorBlink:> I<boolean>	935	=item B<cursorBlink:> I<boolean>
640		936
641	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	937	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
642	option B<-bc>.	938	option B<-bc>.
…		…
655		951
656	Mouse pointer background colour.	952	Mouse pointer background colour.
657		953
658	=item B<pointerBlankDelay:> I<number>	954	=item B<pointerBlankDelay:> I<number>
659		955
660	Specifies number of seconds before blanking the pointer [default 2].	956	Specifies number of seconds before blanking the pointer [default 2]. Use a
		957	large number (e.g. C<987654321>) to effectively disable the timeout.
661		958
662	=item B<backspacekey:> I<string>	959	=item B<backspacekey:> I<string>
663		960
664	The string to send when the backspace key is pressed. If set to B<DEC>	961	The string to send when the backspace key is pressed. If set to B<DEC>
665	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	962	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
672	pressed. If unset it will send the sequence traditionally associated	969	pressed. If unset it will send the sequence traditionally associated
673	with the B<Execute> key.	970	with the B<Execute> key.
674		971
675	=item B<cutchars:> I<string>	972	=item B<cutchars:> I<string>
676		973
677	The characters used as delimiters for double-click word selection. The	974	The characters used as delimiters for double-click word selection
678	built-in default:	975	(whitespace delimiting is added automatically if resource is given).
		976
		977	When the perl selection extension is in use (the default if compiled
		978	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		979	characters will be created (if the resource exists, otherwise, no regex
		980	will be created). In this mode, characters outside ISO-8859-1 can be used.
		981
		982	When the selection extension is not used, only ISO-8859-1 characters can
		983	be used. If not specified, the built-in default is used:
679		984
680	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	985	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
681		986
682	=item B<preeditType:> I<style>	987	=item B<preeditType:> I<style>
683		988
…		…
687		992
688	I<name> of inputMethod to use; option B<-im>.	993	I<name> of inputMethod to use; option B<-im>.
689		994
690	=item B<imLocale:> I<name>	995	=item B<imLocale:> I<name>
691		996
692	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	997	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
693	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	998	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
694	extension to be able to input japanese characters while staying in	999	input extension to be able to input japanese characters while staying in
695	another locale. option B<-imlocale>.	1000	another locale; option B<-imlocale>.
696		1001
697	=item B<insecure>	1002	=item B<imFont:> I<fontset>
		1003
		1004	Specify the font-set used for XIM styles C<OverTheSpot> or
		1005	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		1006	by commas), i.e. it's not in the same format as the other font lists used
		1007	in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
		1008	found, preferably one or two pixels differing in size to the base font.
		1009	option B<-imfont>.
		1010
		1011	=item B<tripleclickwords:> I<boolean>
		1012
		1013	Change the meaning of triple-click selection with the left mouse
		1014	button. Instead of selecting a full line it will extend the selection to
		1015	the end of the logical line only; option B<-tcw>.
		1016
		1017	=item B<insecure:> I<boolean>
698		1018
699	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1019	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
700	echo arbitrary strings like the icon name or the locale. This could be	1020	echo arbitrary strings like the icon name or the locale. This could be
701	abused if somebody gets 8-bit-clean access to your display, wether	1021	abused if somebody gets 8-bit-clean access to your display, whether
702	throuh a mail client displaying mail bodies unfiltered or though	1022	through a mail client displaying mail bodies unfiltered or through
703	write(1). Therefore, these sequences are disabled by default. (Note	1023	write(1) or any other means. Therefore, these sequences are disabled by
704	that other terminals, including xterm, have these sequences	1024	default. (Note that many other terminals, including xterm, have these
705	enabled by default). You can enable them by setting this boolean	1025	sequences enabled by default, which doesn't make it safer, though).
706	resource or specifying B<-insecure> as an option. At the moment, this	1026
707	enabled display-answer, locale, findfont, icon label and window title	1027	You can enable them by setting this boolean resource or specifying
708	requests as well as dynamic menubar dispatch.	1028	B<-insecure> as an option. At the moment, this enables display-answer,
		1029	locale, findfont, icon label and window title requests.
709		1030
710	=item B<modifier:> I<modifier>	1031	=item B<modifier:> I<modifier>
711		1032
712	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1033	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
713	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1034	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
717		1038
718	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1039	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
719	character is passed through. It may contain escape values as described	1040	character is passed through. It may contain escape values as described
720	in the entry on B<keysym> following.	1041	in the entry on B<keysym> following.
721		1042
722	=item B<secondaryScreen:> I<bool>	1043	=item B<secondaryScreen:> I<boolean>
723		1044
724	Turn on/off secondary screen (default enabled).	1045	Turn on/off secondary screen (default enabled).
725		1046
726	=item B<secondaryScroll:> I<bool>	1047	=item B<secondaryScroll:> I<boolean>
727		1048
728	Turn on/off secondary screen scroll (default enabled). If the this	1049	Turn on/off secondary screen scroll (default enabled). If this
729	option is enabled, scrolls on the secondary screen will change the	1050	option is enabled, scrolls on the secondary screen will change the
730	scrollback buffer and switching to/from the secondary screen will	1051	scrollback buffer and switching to/from the secondary screen will
731	instead scroll the screen up.	1052	instead scroll the screen up.
732		1053
		1054	=item B<hold>: I<boolean>
		1055
		1056	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1057	will not immediately destroy its window when the program executed within
		1058	it exits. Instead, it will wait till it is being killed or closed by the
		1059	user.
		1060
733	=item B<keysym.>I<sym>: I<string>	1061	=item B<keysym.>I<sym>: I<string>
734		1062
735	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1063	Compile I<frills>: Associate I<string> with keysym I<sym>. The
736	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	1064	intervening resource name B<keysym.> cannot be omitted.
737	newline, \r: return, \t:	1065
		1066	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		1067	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		1068	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1069	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1070	B<2>, B<3>, B<4>, B<5>.
		1071
		1072	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1073	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1074	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1075	current application keymap mode state.
		1076
		1077	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1078	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1079	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1080	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1081	performed in an exact manner; however, the closest match is assured.
		1082
		1083	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		1084	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
738	tab, \000: octal number) or control characters (^?: delete, ^@: null,	1085	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
739	^A ...) and may enclosed with double quotes so that it can start or end	1086	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
740	with whitespace. The intervening resource name B<keysym.> cannot be	1087	can start or end with whitespace. B<This feature is deprecated and will
741	omitted. This resource is only available when compiled with	1088	be removed>.
742	KEYSYM_RESOURCE.	1089
		1090	Please note that you need to double the C<\> in resource files, as
		1091	Xlib itself does its own de-escaping (you can use C<\033> instead of
		1092	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
		1093	processing).
		1094
		1095	You can define a range of keysyms in one shot by providing a I<string>
		1096	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
		1097	should be a character not used by the strings.
		1098
		1099	Its usage can be demonstrated by an example:
		1100
		1101	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
		1102
		1103	The above line is equivalent to the following three lines:
		1104
		1105	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1106	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1107	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1108
		1109	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1110	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1111	example the following means "change the current locale to C<zh_CN.GBK>
		1112	when Control-Meta-c is being pressed":
		1113
		1114	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1115
		1116	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1117	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1118	manpage. For example, the F<selection> extension (activated via
		1119	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1120
		1121	URxvt.keysym.M-C-c: perl:selection:rot13
		1122
		1123	Due the the large number of modifier combinations, a defined key mapping
		1124	will match if at I<at least> the specified identifiers are being set, and
		1125	no other key mappings with those and more bits are being defined. That
		1126	means that defining a key map for C<a> will automatically provide
		1127	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1128	mappings themselves.
		1129
		1130	Unfortunately, this will override built-in key mappings. For example
		1131	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1132	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1133	user-defined keymap using the C<builtin:> replacement:
		1134
		1135	URxvt.keysym.Insert: <my insert key sequence>
		1136	URxvt.keysym.S-Insert: builtin:
		1137
		1138	The first line defines a mapping for C<Insert> and I<any> combination
		1139	of modifiers. The second line re-establishes the default mapping for
		1140	C<Shift-Insert>.
		1141
		1142	The following example will map Control-Meta-1 and Control-Meta-2 to
		1143	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1144	font-switching at runtime:
		1145
		1146	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1147	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1148
		1149	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1150	info):
		1151
		1152	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1153	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1154
		1155	=item B<perl-ext-common>: I<string>
		1156
		1157	=item B<perl-ext>: I<string>
		1158
		1159	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1160	use in this terminal instance; option B<-pe>.
		1161
		1162	Extension names can be prefixed with a C<-> sign to prohibit using
		1163	them. This can be useful to selectively disable some extensions loaded
		1164	by default, or specified via the C<perl-ext-common> resource. For
		1165	example, C<default,-selection> will use all the default extension except
		1166	C<selection>.
		1167
		1168	Extension names can also be followed by an argument in angle brackets
		1169	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1170	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1171	multiple times with different arguments will pass multiple arguments to
		1172	the extension.
		1173
		1174	Each extension is looked up in the library directories, loaded if
		1175	necessary, and bound to the current terminal instance.
		1176
		1177	If both of these resources are the empty string, then the perl
		1178	interpreter will not be initialized. The idea behind two options is that
		1179	B<perl-ext-common> will be used for extensions that should be available to
		1180	all instances, while B<perl-ext> is used for specific instances.
		1181
		1182	=item B<perl-eval>: I<string>
		1183
		1184	Perl code to be evaluated when all extensions have been registered. See
		1185	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1186	will be ignored when running setuid/setgid.
		1187
		1188	=item B<perl-lib>: I<path>
		1189
		1190	Colon-separated list of additional directories that hold extension
		1191	scripts. When looking for extensions specified by the C<perl> resource,
		1192	@@RXVT_NAME@@ will first look in these directories and then in
		1193	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1194	will be ignored when running setuid/setgid.
		1195
		1196	See the @@RXVT_NAME@@perl(3) manpage.
		1197
		1198	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1199
		1200	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1201	details.
		1202
		1203	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1204
		1205	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1206	for details.
		1207
		1208	=item B<searchable-scrollback:> I<keysym>
		1209
		1210	Sets the hotkey that starts the incremental scrollback buffer search
		1211	(default: C<M-s>).
		1212
		1213	=item B<urlLauncher>: I<string>
		1214
		1215	Specifies the program to be started with a URL argument. Used by the
		1216	C<selection-popup> and C<matcher> perl extensions.
		1217
		1218	=item B<transient-for>: I<windowid>
		1219
		1220	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1221
		1222	=item B<override-redirect>: I<boolean>
		1223
		1224	Compile I<frills>: Sets override-redirect for the terminal window, making
		1225	it almost invisible to window managers; option B<-override-redirect>.
		1226
		1227	=item B<iso14755_52:> I<boolean>
		1228
		1229	Turn on/off ISO 14755 5.2 mode (default enabled).
743		1230
744	=back	1231	=back
745		1232
746	=head1 THE SCROLLBAR	1233	=head1 THE SCROLLBAR
747		1234
…		…
761	the normal text selection/insertion, hold either the Shift or the Meta	1248	the normal text selection/insertion, hold either the Shift or the Meta
762	(Alt) key while performing the desired mouse action.	1249	(Alt) key while performing the desired mouse action.
763		1250
764	If mouse reporting mode is active, the normal scrollbar actions are	1251	If mouse reporting mode is active, the normal scrollbar actions are
765	disabled -- on the assumption that we are using a fullscreen	1252	disabled -- on the assumption that we are using a fullscreen
766	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1253	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
767	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1254	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
768	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1255	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
769	respectively.	1256	respectively.
770		1257
771	=head1 TEXT SELECTION AND INSERTION	1258	=head1 THE SELECTION: SELECTING AND PASTING TEXT
772		1259
773	The behaviour of text selection and insertion mechanism is similar to	1260	The behaviour of text selection and insertion/pasting mechanism is similar
774	I<xterm>(1).	1261	to I<xterm>(1).
775		1262
776	=over 4	1263	=over 4
777		1264
778	=item B<Selection>:	1265	=item B<Selecting>:
779		1266
780	Left click at the beginning of the region, drag to the end of the	1267	Left click at the beginning of the region, drag to the end of the region
781	region and release; Right click to extend the marked region; Left	1268	and release; Right click to extend the marked region; Left double-click
782	double-click to select a word; Left triple-click to select the entire	1269	to select a word; Left triple-click to select the entire logical line
783	line.	1270	(which can span multiple screen lines), unless modified by resource
		1271	B<tripleclickwords>.
784		1272
		1273	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1274	(Compile: I<frills>) will create a rectangular selection instead of a
		1275	normal one. In this mode, every selected row becomes its own line in the
		1276	selection, and trailing whitespace is visually underlined and removed from
		1277	the selection.
		1278
785	=item B<Insertion>:	1279	=item B<Pasting>:
786		1280
787	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1281	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
788	an B<@@RXVT_NAME@@> window causes the current text selection to be	1282	window causes the value of the PRIMARY selection (or CLIPBOARD with the
789	inserted as if it had been typed on the keyboard.	1283	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1284
		1285	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1286	inserted too.
790		1287
791	=back	1288	=back
792		1289
793	=head1 CHANGING FONTS	1290	=head1 CHANGING FONTS
794		1291
795	You can change fonts on-the-fly, which is to say cycle through the	1292	Changing fonts (or font sizes, respectively) via the keypad is not yet
796	default font and others of various sizes, by using B<Shift-KP_Add> and	1293	supported in rxvt-unicode. Bug me if you need this.
797	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1294
798	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1295	You can, however, switch fonts at runtime using escape sequences, e.g.:
799	actual key can be selected using resources	1296
800	B<smallfont_key>/B<bigfont_key>.	1297	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1298
		1299	You can use keyboard shortcuts, too:
		1300
		1301	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1302	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
		1303
		1304	rxvt-unicode will automatically re-apply these fonts to the output so far.
801		1305
802	=head1 ISO 14755 SUPPORT	1306	=head1 ISO 14755 SUPPORT
803		1307
804	Partial ISO 14755-support is implemented. that means that pressing	1308	ISO 14755 is a standard for entering and viewing unicode characters
		1309	and character codes using the keyboard. It consists of 4 parts. The
		1310	first part is available rxvt-unicode has been compiled with
		1311	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1312	with C<--enable-iso14755>.
805		1313
806	Section 5.1: Control and Shift together enters unicode input	1314	=over 4
807	mode. Entering hex digits composes a Unicode character, pressing space or
808	releasing the modifiers commits the keycode and every other key cancels
809	the current input character.
810		1315
811	Section 5.2: Pressing and immediately releasing Control and Shift together	1316	=item * 5.1: Basic method
812	enters keycap entry mode for the next key: pressing a function key (tab,	1317
813	return etc..) will enter the unicode character corresponding to the given	1318	This allows you to enter unicode characters using their hexcode.
814	key.	1319
		1320	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1321	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1322	commit the character as if it were typed directly. While holding down
		1323	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1324	C<Space>, which will commit the current character and lets you start a new
		1325	one.
		1326
		1327	As an example of use, imagine a business card with a japanese e-mail
		1328	address, which you cannot type. Fortunately, the card has the e-mail
		1329	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1330	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1331	followed by releasing the modifier keys.
		1332
		1333	=item * 5.2: Keyboard symbols entry method
		1334
		1335	This mode lets you input characters representing the keycap symbols of
		1336	your keyboard, if representable in the current locale encoding.
		1337
		1338	Start by pressing C<Control> and C<Shift> together, then releasing
		1339	them. The next special key (cursor keys, home etc.) you enter will not
		1340	invoke its usual function but instead will insert the corresponding
		1341	keycap symbol. The symbol will only be entered when the key has been
		1342	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1343	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1344	reverse tab (Shift-Tab).
		1345
		1346	=item * 5.3: Screen-selection entry method
		1347
		1348	While this is implemented already (it's basically the selection
		1349	mechanism), it could be extended by displaying a unicode character map.
		1350
		1351	=item * 5.4: Feedback method for identifying displayed characters for later input
		1352
		1353	This method lets you display the unicode character code associated with
		1354	characters already displayed.
		1355
		1356	You enter this mode by holding down C<Control> and C<Shift> together, then
		1357	pressing and holding the left mouse button and moving around. The unicode
		1358	hex code(s) (it might be a combining character) of the character under the
		1359	pointer is displayed until you release C<Control> and C<Shift>.
		1360
		1361	In addition to the hex codes it will display the font used to draw this
		1362	character - due to implementation reasons, characters combined with
		1363	combining characters, line drawing characters and unknown characters will
		1364	always be drawn using the built-in support font.
		1365
		1366	=back
		1367
		1368	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1369	both scenario A and B of ISO 14755, including part 5.2.
815		1370
816	=head1 LOGIN STAMP	1371	=head1 LOGIN STAMP
817		1372
818	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1373	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
819	that it can be seen via the I<who(1)> command, and can accept messages.	1374	it can be seen via the I<who(1)> command, and can accept messages. To
820	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1375	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
821	some systems.	1376	on some systems or setgid to root or to some other group on others.
822		1377
823	=head1 COLORS AND GRAPHICS	1378	=head1 COLORS AND GRAPHICS
824		1379
825	In addition to the default foreground and background colours,	1380	In addition to the default foreground and background colours,
826	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1381	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
827	high-intensity bold/blink versions of the same). Here is a list of the	1382	high-intensity bold/blink versions of the same). Here is a list of the
828	colours with their B<rgb.txt> names.	1383	colours with their names.
829		1384
830	=begin table	1385	=begin table
831		1386
832	B<color0> (black) = Black	1387	B<color0> (black) = Black
833	B<color1> (red) = Red3	1388	B<color1> (red) = Red3
…		…
853	It is also possible to specify the colour values of B<foreground>,	1408	It is also possible to specify the colour values of B<foreground>,
854	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1409	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
855	a number 0-15, as a convenient shorthand to reference the colour name of	1410	a number 0-15, as a convenient shorthand to reference the colour name of
856	color0-color15.	1411	color0-color15.
857		1412
		1413	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1414	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1415	consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1416	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1417
		1418	Together, all those colours implement the 88 colour xterm colours. Only
		1419	the first 16 can be changed using resources currently, the rest can only
		1420	be changed via command sequences ("escape codes").
		1421
858	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1422	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
859	always swapping the foreground/background colours. This is in contrast to	1423	always swapping the foreground/background colours. This is in contrast to
860	I<xterm>(1) where the colours are only swapped if they have not otherwise	1424	I<xterm>(1) where the colours are only swapped if they have not otherwise
861	been specified. For example,	1425	been specified. For example,
862		1426
…		…
867	would yield White on Black, while on I<xterm>(1) it would yield Black	1431	would yield White on Black, while on I<xterm>(1) it would yield Black
868	on White.	1432	on White.
869		1433
870	=back	1434	=back
871		1435
872	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1436	=head2 ALPHA CHANNEL SUPPORT
		1437
		1438	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1439	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1440	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1441	in addition to the ones provided by X, where the additional A component
		1442	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1443	transparent). You can also prefix any color with C<[percent]>, where
		1444	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1445	the color, where C<0> is completely transparent and C<100> is completelxy
		1446	opaque.
		1447
		1448	You probably need to specify B<"-depth 32">, too, and have the luck that
		1449	your X-server uses ARGB pixel layout, as X is far from just supporting
		1450	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1451
		1452	For example, the following selects an almost completely transparent red
		1453	background, and an almost opaque pink foreground:
		1454
		1455	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1456
		1457	I<Please note that transparency of any kind if completely unsupported by
		1458	the author. Don't bug him with installation questions!>
		1459
		1460	=head1 ENVIRONMENT
		1461
		1462	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
873		1463
874	=over 4	1464	=over 4
875		1465
876	=item How do I know which rxvt-unicode version I'm using?	1466	=item B<TERM>
877		1467
878	The version number is displayed with the usage (-h). For rxvt-unicode	1468	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
879	version 2.14 and later, the escape sequence C<ESC[8n> sets the window	1469	resources or on the command line.
880	title to the version number.
881		1470
882	=item Why do the characters look ugly?	1471	=item B<COLORTERM>
883		1472
884	=item How does rxvt-unicode choose fonts?	1473	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1474	compiled with XPM support, and optionally with the added extension
		1475	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
885		1476
886	Most fonts do not contain the full range of Unicode, which is	1477	=item B<COLORFGBG>
887	fine. Chances are that the font you (or the admin/package maintainer of
888	your system/os) have specified does not cover all the characters you want
889	to display.
890		1478
891	B<rxvt-unicode> makes a best-effort try at finding a replacement	1479	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
892	font. Often the result is fine, but sometimes the chosen font looks	1480	the colour code used as default foreground/text colour (or the string
893	bad. In that case, select a font of your taste and add it to the font	1481	C<default> to indicate that the default-colour escape sequence is to be
894	list, e.g.:	1482	used), C<bg> is the colour code used as default background colour (or the
		1483	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1484	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1485	(and do) use this information to optimize screen output.
895		1486
896	@@RXVT_NAME@@ -fn basefont,font2,font3...	1487	=item B<WINDOWID>
897		1488
898	When rxvt-unicode sees a character, it will first look at the base	1489	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
899	font. If the base font does not contain the character, it will go to the	1490	window, which usually has subwindows for the scrollbar, the terminal
900	next font, and so on.	1491	window and so on).
901		1492
902	The only limitation is that all the fonts must not be larger than the base	1493	=item B<TERMINFO>
903	font, as the base font defines the principial cell size, which must be the
904	same due to the way terminals work.
905		1494
906	=item Why do some chinese characters look so different than others?	1495	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1496	C<--with-terminfo=PATH>.
907		1497
908	This is because there is a difference between script and language --	1498	=item B<DISPLAY>
909	rxvt-unicode does not know which language the text that is output
910	is, as it only knows the unicode character codes. If rxvt-unicode
911	first sees a japanese character, it might choose a japanese font for
912	it. Subseqzuent japanese characters will take that font. Now, many chinese
913	characters aren't represented in japanese fonts, so when the first
914	non-japanese character comes up, rxvt-unicode will look for a chinese font
915	-- unfortunately at this point, it will still use the japanese font for
916	japanese characters that are also chinese.
917		1499
918	The workaround is easy: just tag a chinese font at the end of your font	1500	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
919	list (see the previous question). The key is to view the font list as	1501	display in its child processes.
920	a preference list: If you expect more japanese, list a japanese font
921	first. If you expect more chinese, put a chinese font first.
922		1502
923	In the future it might be possible to switch preferences at runtime (the	1503	=item B<SHELL>
924	internal data structure has no problem with using different fonts for
925	the same character at the same time, but no interface for this has been
926	designed yet).
927		1504
928	=item Mouse cut/paste suddenly no longer works.	1505	The shell to be used for command execution, defaults to C</bin/sh>.
929		1506
930	Make sure that mouse reporting is actually turned off since killing	1507	=item B<RXVT_SOCKET>
931	some editors prematurely may leave the mouse in mouse report mode. I've
932	heard that tcsh may use mouse reporting unless it otherwise specified. A
933	quick check is to see if cut/paste works when the Alt or Shift keys are
934	depressed. See @@RXVT_NAME@@(7)
935		1508
936	=item What's with this bold/blink stuff?	1509	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1510	@@RXVT_NAME@@d(1).
937		1511
938	If no bold colour is set via C<colorBD:>, bold will invert text using the	1512	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
939	standard foreground colour.
940		1513
941	For the standard background colour, blinking will actually make the	1514	=item B<HOME>
942	text blink when compiled with C<--enable-blinking>. with standard
943	colours. Without C<--enable-blinking>, the blink attribute will be
944	ignored.
945		1515
946	On ANSI colours, bold/blink attributes are used to set high-intensity	1516	Used to locate the default directory for the unix domain socket for
947	foreground/background colors.	1517	daemon communications and to locate various resource files (such as
		1518	C<.Xdefaults>)
948		1519
949	color0-7 are the low-intensity colors.	1520	=item B<XAPPLRESDIR>
950		1521
951	color8-15 are the corresponding high-intensity colors.	1522	Directory where various X resource files are being located.
952		1523
953	=item I don't like the screen colors. How do I change them?	1524	=item B<XENVIRONMENT>
954		1525
955	You can change the screen colors at run-time using F<~/.Xdefaults>	1526	If set and accessible, gives the name of a X resource file to be loaded by
956	resources (or as long-options).
957
958	Here are values that are supposed to resemble a VGA screen,
959	including the murky brown that passes for low-intensity yellow:
960
961	Rxvt*color0: #000000
962	Rxvt*color1: #A80000
963	Rxvt*color2: #00A800
964	Rxvt*color3: #A8A800
965	Rxvt*color4: #0000A8
966	Rxvt*color5: #A800A8
967	Rxvt*color6: #00A8A8
968	Rxvt*color7: #A8A8A8
969
970	Rxvt*color8: #000054
971	Rxvt*color9: #FF0054
972	Rxvt*color10: #00FF54
973	Rxvt*color11: #FFFF54
974	Rxvt*color12: #0000FF
975	Rxvt*color13: #FF00FF
976	Rxvt*color14: #00FFFF
977	Rxvt*color15: #FFFFFF
978
979	=item What's with the strange Backspace/Delete key behaviour?
980
981	Assuming that the physical Backspace key corresponds to the
982	BackSpace keysym (not likely for Linux ... see the following
983	question) there are two standard values that can be used for
984	Backspace: C<^H> and C<^?>.
985
986	Historically, either value is correct, but rxvt-unicode adopts the debian
987	policy of using C<^?> when unsure, because it's the one only only correct
988	choice :).
989
990	Rxvt-unicode tries to inherit the current stty settings and uses the value
991	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
992	started from a terminal (say, from a menu or by remote shell), then the
993	system value of `erase', which corresponds to CERASE in <termios.h>, will
994	be used (which may not be the same as your stty setting).
995
996	For starting a new rxvt-unicode:
997
998	# use Backspace = ^H
999	$ stty erase ^H
1000	$ @@RXVT_NAME@@	1527	@@RXVT_NAME@@.
1001
1002	# use Backspace = ^?
1003	$ stty erase ^?
1004	$ @@RXVT_NAME@@
1005
1006	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1007
1008	For an existing rxvt-unicode:
1009
1010	# use Backspace = ^H
1011	$ stty erase ^H
1012	$ echo -n "^[[36h"
1013
1014	# use Backspace = ^?
1015	$ stty erase ^?
1016	$ echo -n "^[[36l"
1017
1018	This helps satisfy some of the Backspace discrepancies that occur, but
1019	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1020	properly reflects that.
1021
1022	The Delete key is a another casualty of the ill-defined Backspace problem.
1023	To avoid confusion between the Backspace and Delete keys, the Delete
1024	key has been assigned an escape sequence to match the vt100 for Execute
1025	(ESC[3~) and is in the supplied termcap/terminfo.
1026
1027	Some other Backspace problems:
1028
1029	some editors use termcap/terminfo,
1030	some editors (vim I'm told) expect Backspace = ^H,
1031	GNU Emacs (and Emacs-like editors) use ^H for help.
1032
1033	Perhaps someday this will all be resolved in a consistent manner.
1034
1035	=item I don't like the key-bindings. How do I change them?
1036
1037	There are some compile-time selections available via configure. Unless
1038	you have run "configure" with the C<--disable-resources> option you can
1039	use the `keysym' resource to alter the keystrings associated with keysym
1040	0xFF00 - 0xFFFF (function, cursor keys, etc).
1041
1042	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1043
1044	!# ----- special uses ------:
1045	! tn3270 login, remap function and arrow keys.
1046	tn3270*font: *clean-bold-*-*--15-*
1047
1048	! keysym - used by rxvt only
1049	! Delete - ^D
1050	tn3270*keysym.0xFFFF: \004
1051
1052	! Home - ^A
1053	tn3270*keysym.0xFF50: \001
1054	! Left - ^B
1055	tn3270*keysym.0xFF51: \002
1056	! Up - ^P
1057	tn3270*keysym.0xFF52: \020
1058	! Right - ^F
1059	tn3270*keysym.0xFF53: \006
1060	! Down - ^N
1061	tn3270*keysym.0xFF54: \016
1062	! End - ^E
1063	tn3270*keysym.0xFF57: \005
1064
1065	! F1 - F12
1066	tn3270*keysym.0xFFBE: \e1
1067	tn3270*keysym.0xFFBF: \e2
1068	tn3270*keysym.0xFFC0: \e3
1069	tn3270*keysym.0xFFC1: \e4
1070	tn3270*keysym.0xFFC2: \e5
1071	tn3270*keysym.0xFFC3: \e6
1072	tn3270*keysym.0xFFC4: \e7
1073	tn3270*keysym.0xFFC5: \e8
1074	tn3270*keysym.0xFFC6: \e9
1075	tn3270*keysym.0xFFC7: \e0
1076	tn3270*keysym.0xFFC8: \e-
1077	tn3270*keysym.0xFFC9: \e=
1078
1079	! map Prior/Next to F7/F8
1080	tn3270*keysym.0xFF55: \e7
1081	tn3270*keysym.0xFF56: \e8
1082
1083	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1084	How do I make use of them? For example, the Sun Keyboard type 4
1085	has the following mappings that rxvt-unicode doesn't recognize.
1086
1087	KP_Insert == Insert
1088	F22 == Print
1089	F27 == Home
1090	F29 == Prior
1091	F33 == End
1092	F35 == Next
1093
1094	Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1095	mappings, it is better to use `xmodmap' to remap the keys as required for
1096	your particular machine.
1097
1098	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1099	I need this to decide about setting colors etc.
1100
1101	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1102	check and see if that is set. Note that several programs, JED, slrn,
1103	Midnight Commander automatically check this variable to decide whether or
1104	not to use color.
1105
1106	=item How do I set the correct, full IP address for the DISPLAY variable?
1107
1108	If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1109	insecure mode then it is possible to use the following shell script
1110	snippets to correctly set the display. If your version of rxvt-unicode
1111	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1112	the COLORTERM variable can be used to distinguish rxvt-unicode from a
1113	regular xterm.
1114
1115	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1116	snippets:
1117
1118	# Bourne/Korn/POSIX family of shells:
1119	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1120	if [ ${TERM:-foo} = xterm ]; then
1121	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1122	echo -n '^[Z'
1123	read term_id
1124	stty icanon echo
1125	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1126	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1127	read DISPLAY # set it in our local shell
1128	fi
1129	fi
1130
1131	=item How do I compile the manual pages for myself?
1132
1133	You need to have a recent version of perl installed as F</usr/bin/perl>,
1134	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1135	the doc subdirectory and enter C<make alldoc>.
1136		1528
1137	=back	1529	=back
1138		1530
1139	=head1 ENVIRONMENT
1140
1141	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1142	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1143	window id number of the B<@@RXVT_NAME@@> window and it also uses and
1144	sets the environment variable B<DISPLAY> to specify which display
1145	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1146	B<RXVTPATH> and B<PATH> to find XPM files.
1147
1148	=head1 FILES	1531	=head1 FILES
1149		1532
1150	=over 4	1533	=over 4
1151		1534
1152	=item B</etc/utmp>
1153
1154	System file for login records.
1155
1156	=item B</usr/lib/X11/rgb.txt>	1535	=item B</usr/lib/X11/rgb.txt>
1157		1536
1158	Color names.	1537	Color names.
1159		1538
1160	=back	1539	=back
1161		1540
1162	=head1 SEE ALSO	1541	=head1 SEE ALSO
1163		1542
1164	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1543	@@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)
1165
1166	=head1 BUGS
1167
1168	Check the BUGS file for an up-to-date list.
1169
1170	Cursor change support is not yet implemented.
1171
1172	Click-and-drag doesn't work with X11 mouse report overriding.
1173		1544
1174	=head1 CURRENT PROJECT COORDINATOR	1545	=head1 CURRENT PROJECT COORDINATOR
1175		1546
1176	=over 4	1547	=over 4
1177		1548
1178	=item Project Coordinator	1549	=item Project Coordinator
1179		1550
1180	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1551	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1181		1552
1182	=item Web page maintainter	1553	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1183
1184	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1185
1186	L<@@RXVT_WEBPAGE@@>
1187		1554
1188	=back	1555	=back
1189		1556
1190	=head1 AUTHORS	1557	=head1 AUTHORS
1191		1558
…		…
1213		1580
1214	Project Coordinator (changes.txt 2.21a to 2.4.5)	1581	Project Coordinator (changes.txt 2.21a to 2.4.5)
1215		1582
1216	=item Geoff Wing L<< <gcw@pobox.com> >>	1583	=item Geoff Wing L<< <gcw@pobox.com> >>
1217		1584
1218	Rewrote screen display and text selection routines. Project Coordinator	1585	Rewrote screen display and text selection routines.
		1586
1219	(changes.txt 2.4.6 - rxvt-unicode)	1587	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1220		1588
1221	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1589	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1222		1590
1223	Forked rxvt-unicode, rewrote most of the display code and internal	1591	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1224	character handling to store text in unicode, improve xterm	1592	extension, random hacks, numerous bugfixes and extensions.
1225	compatibility and apply numerous other bugfixes and extensions.
1226		1593
1227	Project Coordinator (Changes 1.0 -)	1594	Project Coordinator (Changes 1.0 -)
1228		1595
		1596	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1597
		1598	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1599
1229	=back	1600	=back
1230		1601

Diff Legend

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