ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.5 by root, Sat Aug 14 03:00:32 2004 UTC vs.
Revision 1.115 by root, Mon Jul 10 04:01:33 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
21	world. Being a terminal emulator, however, some things are very difficult,	28	world. Being a terminal emulator, however, some things are very difficult,
22	especially cursive scripts such as arabic, vertically written scripts	29	especially cursive scripts such as arabic, vertically written scripts
23	like mongolian or scripts requiring extremely complex combining rules,	30	like mongolian or scripts requiring extremely complex combining rules,
24	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devenagari. Don't expect pretty output when using these
25	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26	fine, though. A somewhat difficult case are left-to-right scripts, such	33	fine, though. A somewhat difficult case are right-to-left scripts, such
27	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
29	such as cursor-movement -- break othwerwise).	36	such as cursor-movement while editing -- break otherwise), but that might
		37	change.
30		38
		39	If you are looking for a terminal that supports more exotic scripts, let
		40	me recommend C<mlterm>, which is a very userfriendly, lean and clean
		41	terminal emulator. In fact, the reason rxvt-unicode was born was solely
		42	because the author couldn't get C<mlterm> to use one font for latin1 and
		43	another for japanese.
		44
31	Another design rationale was the use of multiple fonts to display	45	Therefore another design rationale was the use of multiple fonts to
32	characters: The idea of a single unicode font which many other programs	46	display characters: The idea of a single unicode font which many other
33	force onto it's users never made sense to me: You should be able to choose	47	programs force onto its users never made sense to me: You should be able
34	any font for any script.	48	to choose any font for any script freely.
35		49
36	Apart from that, rxvt-unicode is also much better internationalised than	50	Apart from that, rxvt-unicode is also much better internationalised than
37	it's predecessor, supports things such as XFT and ISO 14755 that are handy	51	its predecessor, supports things such as XFT and ISO 14755 that are handy
38	in i18n-environments, is faster, and has a lot less bugs than the original	52	in i18n-environments, is faster, and has a lot less bugs than the original
39	rxvt. This all in addition to dozens of other small improvements.	53	rxvt. This all in addition to dozens of other small improvements.
40		54
41	It is still faithfully following the original rxvt idea of being lean	55	It is still faithfully following the original rxvt idea of being lean
42	and nice on resources: for example, you can still configure rxvt-unicode	56	and nice on resources: for example, you can still configure rxvt-unicode
43	without most of it's features to get a lean binary. It also comes with	57	without most of its features to get a lean binary. It also comes with
44	a client/daemon pair that lets you open any number of terminal windows	58	a client/daemon pair that lets you open any number of terminal windows
45	from within a single process, which makes startup time very fast and	59	from within a single process, which makes startup time very fast and
46	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
47	@@RXVT_NAME@@c(1) (client).	61	@@RXVT_NAME@@c(1) (client).
48		62
49	It also makes technical information about escape sequences (which have	63	It also makes technical information about escape sequences (which have
50	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	64	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
51	reference documentation (escape sequences etc.) and the FAQ section at the	65	reference documentation (escape sequences etc.).
52	end of this document.
53		66
54	=head1 OPTIONS	67	=head1 OPTIONS
55		68
56	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
57	below. In keeping with the smaller-is-better philosophy, options may be	70	below. In keeping with the smaller-is-better philosophy, options may be
…		…
80		93
81	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
82	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
83	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
84		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<xft>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
85	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
86		104
87	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
88		106
89	=item B<-rv>|B<+rv>	107	=item B<-rv>|B<+rv>
…		…
92		110
93	=item B<-j>|B<+j>	111	=item B<-j>|B<+j>
94		112
95	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling; resource B<jumpScroll>.
96		114
97	=item B<-ip>|B<+ip>	115	=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
98		116
99	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off inheriting parent window's pixmap. Alternative form is
100	B<-tr>; resource B<inheritPixmap>.	118	B<-tr>; resource B<inheritPixmap>.
101		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
102	=item B<-fade> I<number>	123	=item B<-fade> I<number>
103		124
104	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>.
105		133
106	=item B<-tint> I<colour>	134	=item B<-tint> I<colour>
107		135
108	Tint the transparent background pixmap with the given colour when	136	Tint the transparent background pixmap with the given colour when
109	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	137	transparency is enabled with B<-tr> or B<-ip>. This only works for
110	option that can be used to brighten or darken the image in addition to	138	non-tiled backgrounds, currently. See also the B<-sh> option that can be
111	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
112		143
113	=item B<-sh>	144	=item B<-sh>
114		145
115	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	146	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
116	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
117	specified, too).	148	specified, too, e.g. C<-tint white>).
118		149
119	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
120		151
121	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
122		153
…		…
125	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
126		157
127	=item B<-pixmap> I<file[;geom]>	158	=item B<-pixmap> I<file[;geom]>
128		159
129	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
130	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
131	quotes to avoid special shell interpretation of the `;' in the	162	add quotes to avoid special shell interpretation of the C<;> in the
132	command-line; resource B<backgroundPixmap>.	163	command-line; resource B<backgroundPixmap>.
133		164
134	=item B<-cr> I<colour>	165	=item B<-cr> I<colour>
135		166
136	The cursor colour; resource B<cursorColor>.	167	The cursor colour; resource B<cursorColor>.
…		…
143		174
144	The mouse pointer background colour; resource B<pointerColor2>.	175	The mouse pointer background colour; resource B<pointerColor2>.
145		176
146	=item B<-bd> I<colour>	177	=item B<-bd> I<colour>
147		178
148	The colour of the border between the xterm scrollbar and the text;	179	The colour of the border around the text area and between the scrollbar and the text;
149	resource B<borderColor>.	180	resource B<borderColor>.
150		181
151	=item B<-fn> I<fontname>	182	=item B<-fn> I<fontlist>
152		183
153	Select the fonts to be used. This is a comma seperated list of font	184	Select the fonts to be used. This is a comma separated list of font names
154	names that are used in turn when trying to display Unicode characters.	185	that are checked in order when trying to find glyphs for characters. The
155	The first font defines the cell size for characters; other fonts might	186	first font defines the cell size for characters; other fonts might be
156	be smaller, but not larger. A reasonable default font list is always	187	smaller, but not (in general) larger. A (hopefully) reasonable default
157	appended to it. resource B<font>.	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 its 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"
158		196
159	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
160	section.	198	section of @@RXVT_NAME@@(7).
161		199
		200	=item B<-fb> I<fontlist>
		201
		202	Compile I<font-styles>: The bold font list to use when B<bold> characters
		203	are to be printed. See resource B<boldFont> for details.
		204
		205	=item B<-fi> I<fontlist>
		206
		207	Compile I<font-styles>: The italic font list to use when I<italic>
		208	characters are to be printed. See resource B<italicFont> for details.
		209
		210	=item B<-fbi> I<fontlist>
		211
		212	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
		213	italic> >> characters are to be printed. See resource B<boldItalicFont>
		214	for details.
		215
162	=item B<-rb>|B<+rb>	216	=item B<-is>|B<+is>
163		217
164	Enable "real bold" support. When this option is on, bold text will be	218	Compile I<font-styles>: Bold/Italic font styles imply high intensity
165	displayed using the first available bold font in the font list. Bold	219	foreground/background (default). See resource B<intensityStyles> for
166	fonts should thus be specified in the font list after their	220	details.
167	corresponding regular fonts. If no bold font can be found, a regular
168	font will be used. resource B<realBold>.
169		221
170	=item B<-name> I<name>	222	=item B<-name> I<name>
171		223
172	Specify the application name under which resources are to be obtained,	224	Specify the application name under which resources are to be obtained,
173	rather than the default executable file name. Name should not contain	225	rather than the default executable file name. Name should not contain
…		…
211		263
212	Put scrollbar on right/left; resource B<scrollBar_right>.	264	Put scrollbar on right/left; resource B<scrollBar_right>.
213		265
214	=item B<-st>|B<+st>	266	=item B<-st>|B<+st>
215		267
216	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	268	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
217	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>.
218		278
219	=item B<-bc>|B<+bc>	279	=item B<-bc>|B<+bc>
220		280
221	Blink the cursor; resource B<cursorBlink>.	281	Blink the cursor; resource B<cursorBlink>.
222		282
…		…
245		305
246	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.
247	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
248	decorations; resource B<borderLess>.	308	decorations; resource B<borderLess>.
249		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
250	=item B<-lsp> I<number>	322	=item B<-lsp> I<number>
251		323
252	Compile I<linespace>: Lines (pixel height) to insert between each row	324	Compile I<frills>: Lines (pixel height) to insert between each row of
253	of the display; resource B<linespace>.	325	the display. Useful to work around font rendering problems; resource
		326	B<linespace>.
254		327
255	=item B<-tn> I<termname>	328	=item B<-tn> I<termname>
256		329
257	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
258	B<TERM> environment variable. This terminal type must exist in the	331	B<TERM> environment variable. This terminal type must exist in the
…		…
267	given on the command line. If this option is used, it must be the last	340	given on the command line. If this option is used, it must be the last
268	on the command-line. If there is no B<-e> option then the default is to	341	on the command-line. If there is no B<-e> option then the default is to
269	run the program specified by the B<SHELL> environment variable or,	342	run the program specified by the B<SHELL> environment variable or,
270	failing that, I<sh(1)>.	343	failing that, I<sh(1)>.
271		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
272	=item B<-title> I<text>	350	=item B<-title> I<text>
273		351
274	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
275	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
276	application name; resource B<title>.	354	application name; resource B<title>.
…		…
294		372
295	Compile I<XIM>: input method name. resource B<inputMethod>.	373	Compile I<XIM>: input method name. resource B<inputMethod>.
296		374
297	=item B<-imlocale> I<string>	375	=item B<-imlocale> I<string>
298		376
299	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.
300	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
301	extension to be able to input japanese characters while staying in	379	input extension to be able to input japanese characters while staying in
302	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>.
303		392
304	=item B<-insecure>	393	=item B<-insecure>
305		394
306	Enable "insecure" mode, which currently enables most of the escape	395	Enable "insecure" mode, which currently enables most of the escape
307	sequences that echo strings. See the resource B<insecure> for more	396	sequences that echo strings. See the resource B<insecure> for more
…		…
321	=item B<-ssr>|B<+ssr>	410	=item B<-ssr>|B<+ssr>
322		411
323	Turn on/off secondary screen scroll (default enabled); resource	412	Turn on/off secondary screen scroll (default enabled); resource
324	B<secondaryScroll>.	413	B<secondaryScroll>.
325		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 its 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
326	=item B<-xrm> I<resourcestring>	482	=item B<-pe> I<string>
327		483
328	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
329	available in the instance's argument list. Appears in I<WM_COMMAND> in	485	this terminal instance. See resource B<perl-ext> for details.
330	some window managers.
331		486
332	=back	487	=back
333		488
334	=head1 RESOURCES (available also as long-options)	489	=head1 RESOURCES (available also as long-options)
335		490
336	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	491	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
337	options) compiled into your version.	492	options) compiled into your version.
338		493
339	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
340	Xresource data: using the X libraries (Xrm*-functions) or internal	495	distribution do also load settings from the B<~/.Xresources> file when X
341	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	496	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
342	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	497	with later settings overwriting earlier ones:
343	resources using X11 tools like B<xset>. Many distribution do also load
344	settings from the B<~/.Xresources> file when X starts.
345		498
346	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	499	1. system-wide app-defaults file, either locale-dependent OR global
347	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	500	2. app-defaults file in $XAPPLRESDIR
348	set in XAPPLOADDIR/URxvt (compile-time defined: usually	501	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
349	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	502	4. SCREEN_RESOURCES for the current screen
350	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	503	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		504
351	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	505	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
352	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	506	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
353	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	507	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
354	easily configured, while the class name B<URxvt> allows resources	508	configured, while the class name B<URxvt> allows resources unique to
355	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	509	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
356	shared between different B<@@RXVT_NAME@@> configurations. If no	510	configurations. If no resources are specified, suitable defaults will
357	resources are specified, suitable defaults will be used. Command-line	511	be used. Command-line arguments can be used to override resource
358	arguments can be used to override resource settings. The following	512	settings. The following resources are supported (you might want to
359	resources are allowed:	513	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		514	extensions not documented here):
360		515
361	=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>.
362		522
363	=item B<geometry:> I<geom>	523	=item B<geometry:> I<geom>
364		524
365	Create the window with the specified X window geometry [default 80x24];	525	Create the window with the specified X window geometry [default 80x24];
366	option B<-geometry>.	526	option B<-geometry>.
…		…
382	high-intensity (bold = bright foreground, blink = bright background)	542	high-intensity (bold = bright foreground, blink = bright background)
383	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	543	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
384	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	544	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
385	names used are listed in the B<COLORS AND GRAPHICS> section.	545	names used are listed in the B<COLORS AND GRAPHICS> section.
386		546
		547	Colours higher than 15 cannot be set using resources (yet), but can be
		548	changed using an escape command (see @@RXVT_NAME@@(7)).
		549
		550	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		551	88 colour support). Colours 80-87 are evenly spaces grey steps.
		552
387	=item B<colorBD:> I<colour>	553	=item B<colorBD:> I<colour>
388		554
		555	=item B<colorIT:> I<colour>
		556
389	Use the specified colour to display bold characters when the foreground	557	Use the specified colour to display bold or italic characters when the
390	colour is the default. This option will be ignored if B<realBold> is	558	foreground colour is the default. If font styles are not available
391	enabled.	559	(Compile I<styles>) and this option is unset, reverse video is used instead.
392		560
393	=item B<colorUL:> I<colour>	561	=item B<colorUL:> I<colour>
394		562
395	Use the specified colour to display underlined characters when the	563	Use the specified colour to display underlined characters when the
396	foreground colour is the default.	564	foreground colour is the default.
397		565
398	=item B<colorRV:> I<colour>	566	=item B<colorRV:> I<colour>
399		567
400	Use the specified colour as the background for reverse video	568	Use the specified colour as the background for reverse video
401	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.
402		575
403	=item B<cursorColor:> I<colour>	576	=item B<cursorColor:> I<colour>
404		577
405	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
406	foreground colour; option B<-cr>.	579	foreground colour; option B<-cr>.
…		…
427		600
428	B<True>: make the background inherit the parent windows' pixmap, giving	601	B<True>: make the background inherit the parent windows' pixmap, giving
429	artificial transparency. B<False>: do not inherit the parent windows'	602	artificial transparency. B<False>: do not inherit the parent windows'
430	pixmap.	603	pixmap.
431		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
432	=item B<fading:> I<number>	608	=item B<fading:> I<number>
433		609
434	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>.
435		616
436	=item B<tintColor:> I<colour>	617	=item B<tintColor:> I<colour>
437		618
438	Tint the transparent background pixmap with the given colour.	619	Tint the transparent background pixmap with the given colour; option
		620	B<-tint>.
439		621
440	=item B<shading:> I<number>	622	=item B<shading:> I<number>
441		623
442	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	624	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
443	image in addition to tinting it.	625	image in addition to tinting it.
444		626
445	=item B<fading:> I<number>
446
447	Scale the tint colour by the given percentage.
448
449	=item B<scrollColor:> I<colour>	627	=item B<scrollColor:> I<colour>
450		628
451	Use the specified colour for the scrollbar [default #B2B2B2].	629	Use the specified colour for the scrollbar [default #B2B2B2].
452		630
453	=item B<troughColor:> I<colour>	631	=item B<troughColor:> I<colour>
454		632
455	Use the specified colour for the scrollbar's trough area [default	633	Use the specified colour for the scrollbar's trough area [default
456	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	634	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
		635
		636	=item B<borderColor:> I<colour>
		637
		638	The colour of the border around the text area and between the scrollbar
		639	and the text.
457		640
458	=item B<backgroundPixmap:> I<file[;geom]>	641	=item B<backgroundPixmap:> I<file[;geom]>
459		642
460	Use the specified XPM file (note the `.xpm' extension is optional) for	643	Use the specified XPM file (note the `.xpm' extension is optional) for
461	the background and also optionally specify its scaling with a geometry	644	the background and also optionally specify its scaling with a geometry
…		…
465	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
466	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
467	be magnified beyond 10 times its original size. The maximum permitted	650	be magnified beyond 10 times its original size. The maximum permitted
468	scale is 1000. [default 0x0+50+50]	651	scale is 1000. [default 0x0+50+50]
469		652
470	=item B<menu:> I<file[;tag]>
471
472	Read in the specified menu file (note the `.menu' extension is
473	optional) and also optionally specify a starting tag to find. See the
474	reference documentation for details on the syntax for the menuBar.
475
476	=item B<path:> I<path>	653	=item B<path:> I<path>
477		654
478	Specify the colon-delimited search path for finding files (XPM and	655	Specify the colon-delimited search path for finding XPM files.
479	menus), in addition to the paths specified by the B<RXVTPATH> and
480	B<PATH> environment variables.
481		656
482	=item B<font:> I<fontname>	657	=item B<font:> I<fontlist>
483		658
484	Select the fonts to be used. This is a comma seperated list of font	659	Select the fonts to be used. This is a comma separated list of font names
485	names that are used in turn when trying to display Unicode characters.	660	that are checked in order when trying to find glyphs for characters. The
486	The first font defines the cell size for characters; other fonts might	661	first font defines the cell size for characters; other fonts might be
487	be smaller, but not larger. A reasonable default font list is always	662	smaller, but not (in general) larger. A (hopefully) reasonable default
488	appended to it. option B<-fn>.	663	font list is always appended to it; option B<-fn>.
489		664
490	=item B<realBold:> I<boolean>	665	Each font can either be a standard X11 core font (XLFD) name, with
		666	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
491		667
492	B<True>: Enable "real bold" support. When this option is on, bold text	668	In addition, each font can be prefixed with additional hints and
493	will be displayed using the first available bold font in the font list.	669	specifications enclosed in square brackets (C<[]>). The only available
494	Bold fonts should thus be specified in the font list after their	670	hint currently is C<codeset=codeset-name>, and this is only used for Xft
495	corresponding regular fonts. If no bold font can be found, a regular	671	fonts.
496	font will be used. option B<-rb>. B<False>: Display bold text in a	672
497	regular font, using the color specified with B<colorBD>; option B<+rb>.	673	For example, this font resource
		674
		675	URxvt.font: 9x15bold,\
		676	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		677	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		678	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		679	xft:Code2000:antialias=false
		680
		681	specifies five fonts to be used. The first one is C<9x15bold> (actually
		682	the iso8859-1 version of the second font), which is the base font (because
		683	it is named first) and thus defines the character cell grid to be 9 pixels
		684	wide and 15 pixels high.
		685
		686	The second font is just used to add additional unicode characters not in
		687	the base font, likewise the third, which is unfortunately non-bold, but
		688	the bold version of the font does contain less characters, so this is a
		689	useful supplement.
		690
		691	The third font is an Xft font with aliasing turned off, and the characters
		692	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		693	contains other characters, but we are not interested in them.
		694
		695	The last font is a useful catch-all font that supplies most of the
		696	remaining unicode characters.
		697
		698	=item B<boldFont:> I<fontlist>
		699
		700	=item B<italicFont:> I<fontlist>
		701
		702	=item B<boldItalicFont:> I<fontlist>
		703
		704	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		705	italic> >> characters, respectively.
		706
		707	If specified and non-empty, then the syntax is the same as for the
		708	B<font>-resource, and the given font list will be used as is, which makes
		709	it possible to substitute completely different font styles for bold and
		710	italic.
		711
		712	If unset (the default), a suitable font list will be synthesized by
		713	"morphing" the normal text font list into the desired shape. If that is
		714	not possible, replacement fonts of the desired shape will be tried.
		715
		716	If set, but empty, then this specific style is disabled and the normal
		717	text font will being used for the given style.
		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.
498		726
499	=item B<selectstyle:> I<mode>	727	=item B<selectstyle:> I<mode>
500		728
501	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
502	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
503	xterm style selection.	731	xterm style selection.
504		732
505	=item B<scrollstyle:> I<mode>	733	=item B<scrollstyle:> I<mode>
506		734
507	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
508	the author's favourite..	736	the author's favourite.
509		737
510	=item B<title:> I<string>	738	=item B<title:> I<string>
511		739
512	Set window title string, the default title is the command-line	740	Set window title string, the default title is the command-line
513	specified after the B<-e> option, if any, otherwise the application	741	specified after the B<-e> option, if any, otherwise the application
…		…
545		773
546	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
547	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
548	B<Shift-Print> to include the scrollback as well.	776	B<Shift-Print> to include the scrollback as well.
549		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
550	=item B<scrollBar:> I<boolean>	787	=item B<scrollBar:> I<boolean>
551		788
552	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	789	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
553	disable the scrollbar; option B<+sb>.	790	disable the scrollbar; option B<+sb>.
554		791
…		…
573	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
574	B<+si>.	811	B<+si>.
575		812
576	=item B<scrollWithBuffer:> I<boolean>	813	=item B<scrollWithBuffer:> I<boolean>
577		814
578	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
579	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
580	with scrollback buffer when tty recieves new lines; option B<-sw>.	817	with scrollback buffer when tty recieves new lines; option B<+sw>.
581		818
582	=item B<scrollTtyKeypress:> I<boolean>	819	=item B<scrollTtyKeypress:> I<boolean>
583		820
584	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
585	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
586	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	823	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
587	bottom when a non-special key is pressed; option B<+sk>.	824	bottom when a non-special key is pressed; option B<+sk>.
588		825
589	=item B<smallfont_key:> I<keysym>
590
591	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
592	[default B<@@HOTKEY@@-@@SMALLFONT@@>]
593
594	=item B<bigfont_key:> I<keysym>
595
596	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
597	[default B<@@HOTKEY@@-@@BIGFONT@@>]
598
599	=item B<saveLines:> I<number>	826	=item B<saveLines:> I<number>
600		827
601	Save I<number> lines in the scrollback buffer [default 64]. This	828	Save I<number> lines in the scrollback buffer [default 64]. This
602	resource is limited on most machines to 65535; option B<-sl>.	829	resource is limited on most machines to 65535; option B<-sl>.
603		830
…		…
614	=item B<borderLess:> I<boolean>	841	=item B<borderLess:> I<boolean>
615		842
616	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
617	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>.
618		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
619	=item B<termName:> I<termname>	853	=item B<termName:> I<termname>
620		854
621	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
622	variable; option B<-tn>.	856	variable; option B<-tn>.
623		857
…		…
633		867
634	=item B<mouseWheelScrollPage:> I<boolean>	868	=item B<mouseWheelScrollPage:> I<boolean>
635		869
636	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
637	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>.
638		877
639	=item B<cursorBlink:> I<boolean>	878	=item B<cursorBlink:> I<boolean>
640		879
641	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];
642	option B<-bc>.	881	option B<-bc>.
…		…
655		894
656	Mouse pointer background colour.	895	Mouse pointer background colour.
657		896
658	=item B<pointerBlankDelay:> I<number>	897	=item B<pointerBlankDelay:> I<number>
659		898
660	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.
661		901
662	=item B<backspacekey:> I<string>	902	=item B<backspacekey:> I<string>
663		903
664	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>
665	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>
…		…
672	pressed. If unset it will send the sequence traditionally associated	912	pressed. If unset it will send the sequence traditionally associated
673	with the B<Execute> key.	913	with the B<Execute> key.
674		914
675	=item B<cutchars:> I<string>	915	=item B<cutchars:> I<string>
676		916
677	The characters used as delimiters for double-click word selection. The	917	The characters used as delimiters for double-click word selection
678	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:
679		927
680	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	928	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
681		929
682	=item B<preeditType:> I<style>	930	=item B<preeditType:> I<style>
683		931
…		…
687		935
688	I<name> of inputMethod to use; option B<-im>.	936	I<name> of inputMethod to use; option B<-im>.
689		937
690	=item B<imLocale:> I<name>	938	=item B<imLocale:> I<name>
691		939
692	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.
693	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
694	extension to be able to input japanese characters while staying in	942	input extension to be able to input japanese characters while staying in
695	another locale. option B<-imlocale>.	943	another locale; option B<-imlocale>.
696		944
697	=item B<insecure>	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>.
		959
		960	=item B<insecure:> I<boolean>
698		961
699	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	962	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
700	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
701	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
702	throuh a mail client displaying mail bodies unfiltered or though	965	through a mail client displaying mail bodies unfiltered or through
703	write(1). Therefore, these sequences are disabled by default. (Note	966	write(1) or any other means. Therefore, these sequences are disabled by
704	that other terminals, including xterm, have these sequences	967	default. (Note that many other terminals, including xterm, have these
705	enabled by default). You can enable them by setting this boolean	968	sequences enabled by default, which doesn't make it safer, though).
706	resource or specifying B<-insecure> as an option. At the moment, this	969
707	enabled display-answer, locale, findfont, icon label and window title	970	You can enable them by setting this boolean resource or specifying
708	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.
709		973
710	=item B<modifier:> I<modifier>	974	=item B<modifier:> I<modifier>
711		975
712	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>,
713	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
…		…
717		981
718	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)
719	character is passed through. It may contain escape values as described	983	character is passed through. It may contain escape values as described
720	in the entry on B<keysym> following.	984	in the entry on B<keysym> following.
721		985
722	=item B<secondaryScreen:> I<bool>	986	=item B<secondaryScreen:> I<boolean>
723		987
724	Turn on/off secondary screen (default enabled).	988	Turn on/off secondary screen (default enabled).
725		989
726	=item B<secondaryScroll:> I<bool>	990	=item B<secondaryScroll:> I<boolean>
727		991
728	Turn on/off secondary screen scroll (default enabled). If the this	992	Turn on/off secondary screen scroll (default enabled). If the this
729	option is enabled, scrolls on the secondary screen will change the	993	option is enabled, scrolls on the secondary screen will change the
730	scrollback buffer and switching to/from the secondary screen will	994	scrollback buffer and switching to/from the secondary screen will
731	instead scroll the screen up.	995	instead scroll the screen up.
732		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
733	=item B<keysym.>I<sym>: I<string>	1004	=item B<keysym.>I<sym>: I<string>
734		1005
735	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1006	Compile I<frills>: Associate I<string> with keysym I<sym>. The
736	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	1007	intervening resource name B<keysym.> cannot be omitted.
737	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,
738	tab, \000: octal number) or control characters (^?: delete, ^@: null,	1028	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
739	^A ...) and may enclosed with double quotes so that it can start or end	1029	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
740	with whitespace. The intervening resource name B<keysym.> cannot be	1030	can start or end with whitespace.
741	omitted. This resource is only available when compiled with	1031
742	KEYSYM_RESOURCE.	1032	Please note that you need to double the C<\> in resource files, as
		1033	Xlib itself does its 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>.
743		1168
744	=back	1169	=back
745		1170
746	=head1 THE SCROLLBAR	1171	=head1 THE SCROLLBAR
747		1172
…		…
761	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
762	(Alt) key while performing the desired mouse action.	1187	(Alt) key while performing the desired mouse action.
763		1188
764	If mouse reporting mode is active, the normal scrollbar actions are	1189	If mouse reporting mode is active, the normal scrollbar actions are
765	disabled -- on the assumption that we are using a fullscreen	1190	disabled -- on the assumption that we are using a fullscreen
766	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1191	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
767	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1192	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
768	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1193	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
769	respectively.	1194	respectively.
770		1195
771	=head1 TEXT SELECTION AND INSERTION	1196	=head1 TEXT SELECTION AND INSERTION
772		1197
773	The behaviour of text selection and insertion mechanism is similar to	1198	The behaviour of text selection and insertion mechanism is similar to
…		…
775		1200
776	=over 4	1201	=over 4
777		1202
778	=item B<Selection>:	1203	=item B<Selection>:
779		1204
780	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
781	region and release; Right click to extend the marked region; Left	1206	and release; Right click to extend the marked region; Left double-click
782	double-click to select a word; Left triple-click to select the entire	1207	to select a word; Left triple-click to select the entire logical line
783	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.
784		1216
785	=item B<Insertion>:	1217	=item B<Insertion>:
786		1218
787	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@@>
788	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
789	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.
790		1225
791	=back	1226	=back
792		1227
793	=head1 CHANGING FONTS	1228	=head1 CHANGING FONTS
794		1229
795	You can change fonts on-the-fly, which is to say cycle through the	1230	Changing fonts (or font sizes, respectively) via the keypad is not yet
796	default font and others of various sizes, by using B<Shift-KP_Add> and	1231	supported in rxvt-unicode. Bug me if you need this.
797	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1232
798	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1233	You can, however, switch fonts at runtime using escape sequences, e.g.:
799	actual key can be selected using resources	1234
800	B<smallfont_key>/B<bigfont_key>.	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
		1241
		1242	rxvt-unicode will automatically re-apply these fonts to the output so far.
801		1243
802	=head1 ISO 14755 SUPPORT	1244	=head1 ISO 14755 SUPPORT
803		1245
804	Partial ISO 14755-support is implemented. that means that pressing	1246	ISO 14755 is a standard for entering and viewing unicode characters
		1247	and character codes using the keyboard. It consists of 4 parts. The
		1248	first part is available rxvt-unicode has been compiled with
		1249	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1250	with C<--enable-iso14755>.
805		1251
806	Section 5.1: Control and Shift together enters unicode input	1252	=over 4
807	mode. Entering hex digits composes a Unicode character, pressing space or
808	releasing the modifiers commits the keycode and every other key cancels
809	the current input character.
810		1253
811	Section 5.2: Pressing and immediately releasing Control and Shift together	1254	=item * 5.1: Basic method
812	enters keycap entry mode for the next key: pressing a function key (tab,	1255
813	return etc..) will enter the unicode character corresponding to the given	1256	This allows you to enter unicode characters using their hexcode.
814	key.	1257
		1258	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1259	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1260	commit the character as if it were typed directly. While holding down
		1261	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1262	C<Space>, which will commit the current character and lets you start a new
		1263	one.
		1264
		1265	As an example of use, imagine a business card with a japanese e-mail
		1266	address, which you cannot type. Fortunately, the card has the e-mail
		1267	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1268	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1269	followed by releasing the modifier keys.
		1270
		1271	=item * 5.2: Keyboard symbols entry method
		1272
		1273	This mode lets you input characters representing the keycap symbols of
		1274	your keyboard, if representable in the current locale encoding.
		1275
		1276	Start by pressing C<Control> and C<Shift> together, then releasing
		1277	them. The next special key (cursor keys, home etc.) you enter will not
		1278	invoke its usual function but instead will insert the corresponding
		1279	keycap symbol. The symbol will only be entered when the key has been
		1280	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1281	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1282	reverse tab (Shift-Tab).
		1283
		1284	=item * 5.3: Screen-selection entry method
		1285
		1286	While this is implemented already (it's basically the selection
		1287	mechanism), it could be extended by displaying a unicode character map.
		1288
		1289	=item * 5.4: Feedback method for identifying displayed characters for later input
		1290
		1291	This method lets you display the unicode character code associated with
		1292	characters already displayed.
		1293
		1294	You enter this mode by holding down C<Control> and C<Shift> together, then
		1295	pressing and holding the left mouse button and moving around. The unicode
		1296	hex code(s) (it might be a combining character) of the character under the
		1297	pointer is displayed until you release C<Control> and C<Shift>.
		1298
		1299	In addition to the hex codes it will display the font used to draw this
		1300	character - due to implementation reasons, characters combined with
		1301	combining characters, line drawing characters and unknown characters will
		1302	always be drawn using the built-in support font.
		1303
		1304	=back
		1305
		1306	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1307	both scenario A and B of ISO 14755, including part 5.2.
815		1308
816	=head1 LOGIN STAMP	1309	=head1 LOGIN STAMP
817		1310
818	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
819	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
820	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
821	some systems.	1314	on some systems or setgid to root or to some other group on others.
822		1315
823	=head1 COLORS AND GRAPHICS	1316	=head1 COLORS AND GRAPHICS
824		1317
825	In addition to the default foreground and background colours,	1318	In addition to the default foreground and background colours,
826	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
827	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
828	colours with their B<rgb.txt> names.	1321	colours with their names.
829		1322
830	=begin table	1323	=begin table
831		1324
832	B<color0> (black) = Black	1325	B<color0> (black) = Black
833	B<color1> (red) = Red3	1326	B<color1> (red) = Red3
…		…
853	It is also possible to specify the colour values of B<foreground>,	1346	It is also possible to specify the colour values of B<foreground>,
854	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1347	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
855	a number 0-15, as a convenient shorthand to reference the colour name of	1348	a number 0-15, as a convenient shorthand to reference the colour name of
856	color0-color15.	1349	color0-color15.
857		1350
		1351	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1352	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1353	consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1354	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1355
		1356	Together, all those colours implement the 88 colour xterm colours. Only
		1357	the first 16 can be changed using resources currently, the rest can only
		1358	be changed via command sequences ("escape codes").
		1359
858	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1360	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
859	always swapping the foreground/background colours. This is in contrast to	1361	always swapping the foreground/background colours. This is in contrast to
860	I<xterm>(1) where the colours are only swapped if they have not otherwise	1362	I<xterm>(1) where the colours are only swapped if they have not otherwise
861	been specified. For example,	1363	been specified. For example,
862		1364
…		…
867	would yield White on Black, while on I<xterm>(1) it would yield Black	1369	would yield White on Black, while on I<xterm>(1) it would yield Black
868	on White.	1370	on White.
869		1371
870	=back	1372	=back
871		1373
872	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1374	=head2 ALPHA CHANNEL SUPPORT
		1375
		1376	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1377	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1378	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1379	in addition to the ones provided by X, where the additional A component
		1380	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1381	transparent). You can also prefix any color with C<[a]>, where C<a> is on
		1382	to four hex digits specifiying the opacity value.
		1383
		1384	You probably need to specify B<"-depth 32">, too, and have the luck that
		1385	your X-server uses ARGB pixel layout, as X is far from just supporting
		1386	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1387
		1388	For example, the following selects an almost completely transparent red
		1389	background, and an almost opaque pink foreground:
		1390
		1391	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
		1392
		1393	I<Please note that transparency of any kind if completely unsupported by
		1394	the author. Don't bug him with installation questions!>
		1395
		1396	=head1 ENVIRONMENT
		1397
		1398	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
873		1399
874	=over 4	1400	=over 4
875		1401
876	=item How do I know which rxvt-unicode version I'm using?	1402	=item B<TERM>
877		1403
878	The version number is displayed with the usage (-h). For rxvt-unicode	1404	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
879	version 2.14 and later, the escape sequence C<ESC[8n> sets the window	1405	resources or on the commandline.
880	title to the version number.
881		1406
882	=item Why do the characters look ugly?	1407	=item B<COLORTERM>
883		1408
884	=item How does rxvt-unicode choose fonts?	1409	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1410	compiled with XPM support, and optionally with the added extension
		1411	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
885		1412
886	Most fonts do not contain the full range of Unicode, which is	1413	=item B<COLORFGBG>
887	fine. Chances are that the font you (or the admin/package maintainer of
888	your system/os) have specified does not cover all the characters you want
889	to display.
890		1414
891	B<rxvt-unicode> makes a best-effort try at finding a replacement	1415	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
892	font. Often the result is fine, but sometimes the chosen font looks	1416	the colour code used as default foreground/text colour (or the string
893	bad. In that case, select a font of your taste and add it to the font	1417	C<default> to indicate that the default-colour escape sequence is to be
894	list, e.g.:	1418	used), C<bg> is the colour code used as default background colour (or the
		1419	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1420	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1421	(and do) use this information to optimize screen output.
895		1422
896	@@RXVT_NAME@@ -fn basefont,font2,font3...	1423	=item B<WINDOWID>
897		1424
898	When rxvt-unicode sees a character, it will first look at the base	1425	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
899	font. If the base font does not contain the character, it will go to the	1426	window, which usually has subwindows for the scrollbar, the terminal
900	next font, and so on.	1427	window and so on).
901		1428
902	The only limitation is that all the fonts must not be larger than the base	1429	=item B<TERMINFO>
903	font, as the base font defines the principial cell size, which must be the
904	same due to the way terminals work.
905		1430
906	=item Why do some chinese characters look so different than others?	1431	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1432	C<--with-terminfo=PATH>.
907		1433
908	This is because there is a difference between script and language --	1434	=item B<DISPLAY>
909	rxvt-unicode does not know which language the text that is output
910	is, as it only knows the unicode character codes. If rxvt-unicode
911	first sees a japanese character, it might choose a japanese font for
912	it. Subseqzuent japanese characters will take that font. Now, many chinese
913	characters aren't represented in japanese fonts, so when the first
914	non-japanese character comes up, rxvt-unicode will look for a chinese font
915	-- unfortunately at this point, it will still use the japanese font for
916	japanese characters that are also chinese.
917		1435
918	The workaround is easy: just tag a chinese font at the end of your font	1436	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
919	list (see the previous question). The key is to view the font list as	1437	display in its child processes.
920	a preference list: If you expect more japanese, list a japanese font
921	first. If you expect more chinese, put a chinese font first.
922		1438
923	In the future it might be possible to switch preferences at runtime (the	1439	=item B<SHELL>
924	internal data structure has no problem with using different fonts for
925	the same character at the same time, but no interface for this has been
926	designed yet).
927		1440
928	=item Mouse cut/paste suddenly no longer works.	1441	The shell to be used for command execution, defaults to C</bin/sh>.
929		1442
930	Make sure that mouse reporting is actually turned off since killing	1443	=item B<RXVT_SOCKET>
931	some editors prematurely may leave the mouse in mouse report mode. I've
932	heard that tcsh may use mouse reporting unless it otherwise specified. A
933	quick check is to see if cut/paste works when the Alt or Shift keys are
934	depressed. See @@RXVT_NAME@@(7)
935		1444
936	=item What's with this bold/blink stuff?	1445	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1446	@@RXVT_NAME@@d(1).
937		1447
938	If no bold colour is set via C<colorBD:>, bold will invert text using the	1448	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
939	standard foreground colour.
940		1449
941	For the standard background colour, blinking will actually make the	1450	=item B<HOME>
942	text blink when compiled with C<--enable-blinking>. with standard
943	colours. Without C<--enable-blinking>, the blink attribute will be
944	ignored.
945		1451
946	On ANSI colours, bold/blink attributes are used to set high-intensity	1452	Used to locate the default directory for the unix domain socket for
947	foreground/background colors.	1453	daemon communications and to locate various resource files (such as
		1454	C<.Xdefaults>)
948		1455
949	color0-7 are the low-intensity colors.	1456	=item B<XAPPLRESDIR>
950		1457
951	color8-15 are the corresponding high-intensity colors.	1458	Directory where various X resource files are being located.
952		1459
953	=item I don't like the screen colors. How do I change them?	1460	=item B<XENVIRONMENT>
954		1461
955	You can change the screen colors at run-time using F<~/.Xdefaults>	1462	If set and accessible, gives the name of a X resource file to be loaded by
956	resources (or as long-options).
957
958	Here are values that are supposed to resemble a VGA screen,
959	including the murky brown that passes for low-intensity yellow:
960
961	Rxvt*color0: #000000
962	Rxvt*color1: #A80000
963	Rxvt*color2: #00A800
964	Rxvt*color3: #A8A800
965	Rxvt*color4: #0000A8
966	Rxvt*color5: #A800A8
967	Rxvt*color6: #00A8A8
968	Rxvt*color7: #A8A8A8
969
970	Rxvt*color8: #000054
971	Rxvt*color9: #FF0054
972	Rxvt*color10: #00FF54
973	Rxvt*color11: #FFFF54
974	Rxvt*color12: #0000FF
975	Rxvt*color13: #FF00FF
976	Rxvt*color14: #00FFFF
977	Rxvt*color15: #FFFFFF
978
979	=item What's with the strange Backspace/Delete key behaviour?
980
981	Assuming that the physical Backspace key corresponds to the
982	BackSpace keysym (not likely for Linux ... see the following
983	question) there are two standard values that can be used for
984	Backspace: C<^H> and C<^?>.
985
986	Historically, either value is correct, but rxvt-unicode adopts the debian
987	policy of using C<^?> when unsure, because it's the one only only correct
988	choice :).
989
990	Rxvt-unicode tries to inherit the current stty settings and uses the value
991	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
992	started from a terminal (say, from a menu or by remote shell), then the
993	system value of `erase', which corresponds to CERASE in <termios.h>, will
994	be used (which may not be the same as your stty setting).
995
996	For starting a new rxvt-unicode:
997
998	# use Backspace = ^H
999	$ stty erase ^H
1000	$ @@RXVT_NAME@@	1463	@@RXVT_NAME@@.
1001
1002	# use Backspace = ^?
1003	$ stty erase ^?
1004	$ @@RXVT_NAME@@
1005
1006	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1007
1008	For an existing rxvt-unicode:
1009
1010	# use Backspace = ^H
1011	$ stty erase ^H
1012	$ echo -n "^[[36h"
1013
1014	# use Backspace = ^?
1015	$ stty erase ^?
1016	$ echo -n "^[[36l"
1017
1018	This helps satisfy some of the Backspace discrepancies that occur, but
1019	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1020	properly reflects that.
1021
1022	The Delete key is a another casualty of the ill-defined Backspace problem.
1023	To avoid confusion between the Backspace and Delete keys, the Delete
1024	key has been assigned an escape sequence to match the vt100 for Execute
1025	(ESC[3~) and is in the supplied termcap/terminfo.
1026
1027	Some other Backspace problems:
1028
1029	some editors use termcap/terminfo,
1030	some editors (vim I'm told) expect Backspace = ^H,
1031	GNU Emacs (and Emacs-like editors) use ^H for help.
1032
1033	Perhaps someday this will all be resolved in a consistent manner.
1034
1035	=item I don't like the key-bindings. How do I change them?
1036
1037	There are some compile-time selections available via configure. Unless
1038	you have run "configure" with the C<--disable-resources> option you can
1039	use the `keysym' resource to alter the keystrings associated with keysym
1040	0xFF00 - 0xFFFF (function, cursor keys, etc).
1041
1042	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1043
1044	!# ----- special uses ------:
1045	! tn3270 login, remap function and arrow keys.
1046	tn3270*font: *clean-bold-*-*--15-*
1047
1048	! keysym - used by rxvt only
1049	! Delete - ^D
1050	tn3270*keysym.0xFFFF: \004
1051
1052	! Home - ^A
1053	tn3270*keysym.0xFF50: \001
1054	! Left - ^B
1055	tn3270*keysym.0xFF51: \002
1056	! Up - ^P
1057	tn3270*keysym.0xFF52: \020
1058	! Right - ^F
1059	tn3270*keysym.0xFF53: \006
1060	! Down - ^N
1061	tn3270*keysym.0xFF54: \016
1062	! End - ^E
1063	tn3270*keysym.0xFF57: \005
1064
1065	! F1 - F12
1066	tn3270*keysym.0xFFBE: \e1
1067	tn3270*keysym.0xFFBF: \e2
1068	tn3270*keysym.0xFFC0: \e3
1069	tn3270*keysym.0xFFC1: \e4
1070	tn3270*keysym.0xFFC2: \e5
1071	tn3270*keysym.0xFFC3: \e6
1072	tn3270*keysym.0xFFC4: \e7
1073	tn3270*keysym.0xFFC5: \e8
1074	tn3270*keysym.0xFFC6: \e9
1075	tn3270*keysym.0xFFC7: \e0
1076	tn3270*keysym.0xFFC8: \e-
1077	tn3270*keysym.0xFFC9: \e=
1078
1079	! map Prior/Next to F7/F8
1080	tn3270*keysym.0xFF55: \e7
1081	tn3270*keysym.0xFF56: \e8
1082
1083	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1084	How do I make use of them? For example, the Sun Keyboard type 4
1085	has the following mappings that rxvt-unicode doesn't recognize.
1086
1087	KP_Insert == Insert
1088	F22 == Print
1089	F27 == Home
1090	F29 == Prior
1091	F33 == End
1092	F35 == Next
1093
1094	Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1095	mappings, it is better to use `xmodmap' to remap the keys as required for
1096	your particular machine.
1097
1098	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1099	I need this to decide about setting colors etc.
1100
1101	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1102	check and see if that is set. Note that several programs, JED, slrn,
1103	Midnight Commander automatically check this variable to decide whether or
1104	not to use color.
1105
1106	=item How do I set the correct, full IP address for the DISPLAY variable?
1107
1108	If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1109	insecure mode then it is possible to use the following shell script
1110	snippets to correctly set the display. If your version of rxvt-unicode
1111	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1112	the COLORTERM variable can be used to distinguish rxvt-unicode from a
1113	regular xterm.
1114
1115	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1116	snippets:
1117
1118	# Bourne/Korn/POSIX family of shells:
1119	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1120	if [ ${TERM:-foo} = xterm ]; then
1121	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1122	echo -n '^[Z'
1123	read term_id
1124	stty icanon echo
1125	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1126	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1127	read DISPLAY # set it in our local shell
1128	fi
1129	fi
1130
1131	=item How do I compile the manual pages for myself?
1132
1133	You need to have a recent version of perl installed as F</usr/bin/perl>,
1134	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1135	the doc subdirectory and enter C<make alldoc>.
1136		1464
1137	=back	1465	=back
1138		1466
1139	=head1 ENVIRONMENT
1140
1141	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1142	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1143	window id number of the B<@@RXVT_NAME@@> window and it also uses and
1144	sets the environment variable B<DISPLAY> to specify which display
1145	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1146	B<RXVTPATH> and B<PATH> to find XPM files.
1147
1148	=head1 FILES	1467	=head1 FILES
1149		1468
1150	=over 4	1469	=over 4
1151		1470
1152	=item B</etc/utmp>
1153
1154	System file for login records.
1155
1156	=item B</usr/lib/X11/rgb.txt>	1471	=item B</usr/lib/X11/rgb.txt>
1157		1472
1158	Color names.	1473	Color names.
1159		1474
1160	=back	1475	=back
1161		1476
1162	=head1 SEE ALSO	1477	=head1 SEE ALSO
1163		1478
1164	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1479	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1165
1166	=head1 BUGS
1167
1168	Check the BUGS file for an up-to-date list.
1169
1170	Cursor change support is not yet implemented.
1171
1172	Click-and-drag doesn't work with X11 mouse report overriding.
1173		1480
1174	=head1 CURRENT PROJECT COORDINATOR	1481	=head1 CURRENT PROJECT COORDINATOR
1175		1482
1176	=over 4	1483	=over 4
1177		1484
1178	=item Project Coordinator	1485	=item Project Coordinator
1179		1486
1180	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1487	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1181		1488
1182	=item Web page maintainter	1489	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1183
1184	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1185
1186	L<@@RXVT_WEBPAGE@@>
1187		1490
1188	=back	1491	=back
1189		1492
1190	=head1 AUTHORS	1493	=head1 AUTHORS
1191		1494
…		…
1213		1516
1214	Project Coordinator (changes.txt 2.21a to 2.4.5)	1517	Project Coordinator (changes.txt 2.21a to 2.4.5)
1215		1518
1216	=item Geoff Wing L<< <gcw@pobox.com> >>	1519	=item Geoff Wing L<< <gcw@pobox.com> >>
1217		1520
1218	Rewrote screen display and text selection routines. Project Coordinator	1521	Rewrote screen display and text selection routines.
		1522
1219	(changes.txt 2.4.6 - rxvt-unicode)	1523	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1220		1524
1221	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1525	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1222		1526
1223	Forked rxvt-unicode, rewrote most of the display code and internal	1527	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1224	character handling to store text in unicode, improve xterm	1528	extension, random hacks, numerous bugfixes and extensions.
1225	compatibility and apply numerous other bugfixes and extensions.
1226		1529
1227	Project Coordinator (Changes 1.0 -)	1530	Project Coordinator (Changes 1.0 -)
1228		1531
		1532	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1533
		1534	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1535
1229	=back	1536	=back
1230		1537

Diff Legend

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