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

Diff Legend

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