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

Diff Legend

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