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.104 by root, Wed Jan 25 13:24:45 2006 UTC

…		…
11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal	11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
		16
		17	=head1 FREQUENTLY ASKED QUESTIONS
		18
		19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
		20	frequently asked questions and answer to them and some common
		21	problems. That document is also accessible on the World-Wide-Web at
		22	L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
16		23
17	=head1 RXVT-UNICODE VS. RXVT	24	=head1 RXVT-UNICODE VS. RXVT
18		25
19	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
20	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
…		…
24	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devenagari. Don't expect pretty output when using these
25	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26	fine, though. A somewhat difficult case are left-to-right scripts, such	33	fine, though. A somewhat difficult case are left-to-right scripts, such
27	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
29	such as cursor-movement -- 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 it's 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	it's 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.
…		…
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
…		…
92		105
93	=item B<-j>|B<+j>	106	=item B<-j>|B<+j>
94		107
95	Turn on/off jump scrolling; resource B<jumpScroll>.	108	Turn on/off jump scrolling; resource B<jumpScroll>.
96		109
97	=item B<-ip>|B<+ip>	110	=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
98		111
99	Turn on/off inheriting parent window's pixmap. Alternative form is	112	Turn on/off inheriting parent window's pixmap. Alternative form is
100	B<-tr>; resource B<inheritPixmap>.	113	B<-tr>; resource B<inheritPixmap>.
101		114
102	=item B<-fade> I<number>	115	=item B<-fade> I<number>
103		116
104	Fade the text by the given percentage when focus is lost.	117	Fade the text by the given percentage when focus is lost. Small values
		118	fade a little only, 100 completely replaces all colours by the fade
		119	colour; resource B<fading>.
		120
		121	=item B<-fadecolor> I<colour>
		122
		123	Fade to this colour when fading is used (see B<-fade>). The default colour
		124	is black. resource B<fadeColor>.
105		125
106	=item B<-tint> I<colour>	126	=item B<-tint> I<colour>
107		127
108	Tint the transparent background pixmap with the given colour when	128	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>	129	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	130	non-tiled backgrounds, currently. See also the B<-sh> option that can be
111	tinting it.	131	used to brighten or darken the image in addition to tinting it; resource
		132	I<tintColor>. Example:
		133
		134	@@RXVT_NAME@@ -tr -tint blue -sh 40
112		135
113	=item B<-sh>	136	=item B<-sh>
114		137
115	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	138	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	139	background image in addition to tinting it (i.e. B<-tint> must be
117	specified, too).	140	specified, too, e.g. C<-tint white>).
118		141
119	=item B<-bg> I<colour>	142	=item B<-bg> I<colour>
120		143
121	Window background colour; resource B<background>.	144	Window background colour; resource B<background>.
122		145
…		…
125	Window foreground colour; resource B<foreground>.	148	Window foreground colour; resource B<foreground>.
126		149
127	=item B<-pixmap> I<file[;geom]>	150	=item B<-pixmap> I<file[;geom]>
128		151
129	Compile I<XPM>: Specify XPM file for the background and also optionally	152	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	153	specify its scaling with a geometry string. Note you may need to
131	quotes to avoid special shell interpretation of the `;' in the	154	add quotes to avoid special shell interpretation of the C<;> in the
132	command-line; resource B<backgroundPixmap>.	155	command-line; resource B<backgroundPixmap>.
133		156
134	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
135		158
136	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
…		…
143		166
144	The mouse pointer background colour; resource B<pointerColor2>.	167	The mouse pointer background colour; resource B<pointerColor2>.
145		168
146	=item B<-bd> I<colour>	169	=item B<-bd> I<colour>
147		170
148	The colour of the border between the xterm scrollbar and the text;	171	The colour of the border around the text area and between the scrollbar and the text;
149	resource B<borderColor>.	172	resource B<borderColor>.
150		173
151	=item B<-fn> I<fontname>	174	=item B<-fn> I<fontlist>
152		175
153	Select the fonts to be used. This is a comma seperated list of font	176	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.	177	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	178	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	179	smaller, but not (in general) larger. A (hopefully) reasonable default
157	appended to it. resource B<font>.	180	font list is always appended to it. See resource B<font> for more details.
		181
		182	In short, to specify an X11 core font, just specify it's name or prefix it
		183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		184	e.g.:
		185
		186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
158		188
159	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	189	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
160	section.	190	section of @@RXVT_NAME@@(7).
161		191
		192	=item B<-fb> I<fontlist>
		193
		194	Compile I<font-styles>: The bold font list to use when B<bold> characters
		195	are to be printed. See resource B<boldFont> for details.
		196
		197	=item B<-fi> I<fontlist>
		198
		199	Compile I<font-styles>: The italic font list to use when I<italic>
		200	characters are to be printed. See resource B<italicFont> for details.
		201
		202	=item B<-fbi> I<fontlist>
		203
		204	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
		205	italic> >> characters are to be printed. See resource B<boldItalicFont>
		206	for details.
		207
162	=item B<-rb>|B<+rb>	208	=item B<-is>|B<+is>
163		209
164	Enable "real bold" support. When this option is on, bold text will be	210	Compile I<font-styles>: Bold/Italic font styles imply high intensity
165	displayed using the first available bold font in the font list. Bold	211	foreground/background (default). See resource B<intensityStyles> for
166	fonts should thus be specified in the font list after their	212	details.
167	corresponding regular fonts. If no bold font can be found, a regular
168	font will be used. resource B<realBold>.
169		213
170	=item B<-name> I<name>	214	=item B<-name> I<name>
171		215
172	Specify the application name under which resources are to be obtained,	216	Specify the application name under which resources are to be obtained,
173	rather than the default executable file name. Name should not contain	217	rather than the default executable file name. Name should not contain
…		…
211		255
212	Put scrollbar on right/left; resource B<scrollBar_right>.	256	Put scrollbar on right/left; resource B<scrollBar_right>.
213		257
214	=item B<-st>|B<+st>	258	=item B<-st>|B<+st>
215		259
216	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	260	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
217	resource B<scrollBar_floating>.	261	resource B<scrollBar_floating>.
		262
		263	=item B<-ptab>|B<+ptab>
		264
		265	If enabled (default), "Horizontal Tab" characters are being stored as
		266	actual wide characters in the screen buffer, which makes it possible to
		267	select and paste them. Since a horizontal tab is a cursor movement and
		268	not an actual glyph, this can sometimes be visually annoying as the cursor
		269	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
218		270
219	=item B<-bc>|B<+bc>	271	=item B<-bc>|B<+bc>
220		272
221	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
222		274
…		…
245		297
246	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	298	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	299	if honoured by the WM, the rxvt-unicode window will not have window
248	decorations; resource B<borderLess>.	300	decorations; resource B<borderLess>.
249		301
		302	=item B<-override-redirect>
		303
		304	Compile I<frills>: Sets override-redirect on the window; resource
		305	B<override-redirect>.
		306
		307	=item B<-sbg>
		308
		309	Compile I<frills>: Disable the usage of the built-in block graphics/line
		310	drawing characters and just rely on what the specified fonts provide. Use
		311	this if you have a good font and want to use its block graphic glyphs;
		312	resource B<skipBuiltinGlyphs>.
		313
250	=item B<-lsp> I<number>	314	=item B<-lsp> I<number>
251		315
252	Compile I<linespace>: Lines (pixel height) to insert between each row	316	Compile I<frills>: Lines (pixel height) to insert between each row of
253	of the display; resource B<linespace>.	317	the display. Useful to work around font rendering problems; resource
		318	B<linespace>.
254		319
255	=item B<-tn> I<termname>	320	=item B<-tn> I<termname>
256		321
257	This option specifies the name of the terminal type to be set in the	322	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	323	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	332	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	333	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,	334	run the program specified by the B<SHELL> environment variable or,
270	failing that, I<sh(1)>.	335	failing that, I<sh(1)>.
271		336
		337	Please note that you must specify a program with arguments. If you want to
		338	run shell commands, you have to specify the shell, like this:
		339
		340	@@RXVT_NAME@@ -e sh -c "shell commands"
		341
272	=item B<-title> I<text>	342	=item B<-title> I<text>
273		343
274	Window title (B<-T> still respected); the default title is the basename	344	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	345	of the program specified after the B<-e> option, if any, otherwise the
276	application name; resource B<title>.	346	application name; resource B<title>.
…		…
294		364
295	Compile I<XIM>: input method name. resource B<inputMethod>.	365	Compile I<XIM>: input method name. resource B<inputMethod>.
296		366
297	=item B<-imlocale> I<string>	367	=item B<-imlocale> I<string>
298		368
299	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	369	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	370	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	371	input extension to be able to input japanese characters while staying in
302	another locale.	372	another locale. resource B<imLocale>.
		373
		374	=item B<-imfont> I<fontset>
		375
		376	Set the font set to use for the X Input Method, see resource B<imFont>
		377	for more info.
		378
		379	=item B<-tcw>
		380
		381	Change the meaning of triple-click selection with the left mouse
		382	button. Instead of selecting a full line it will extend the selection the
		383	end of the logical line only. resource B<tripleclickwords>.
303		384
304	=item B<-insecure>	385	=item B<-insecure>
305		386
306	Enable "insecure" mode, which currently enables most of the escape	387	Enable "insecure" mode, which currently enables most of the escape
307	sequences that echo strings. See the resource B<insecure> for more	388	sequences that echo strings. See the resource B<insecure> for more
…		…
321	=item B<-ssr>|B<+ssr>	402	=item B<-ssr>|B<+ssr>
322		403
323	Turn on/off secondary screen scroll (default enabled); resource	404	Turn on/off secondary screen scroll (default enabled); resource
324	B<secondaryScroll>.	405	B<secondaryScroll>.
325		406
		407	=item B<-hold>|B<+hold>
		408
		409	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		410	will not immediately destroy its window when the program executed within
		411	it exits. Instead, it will wait till it is being killed or closed by the
		412	user; resource B<hold>.
		413
		414	=item B<-keysym.>I<sym> I<string>
		415
		416	Remap a key symbol. See resource B<keysym>.
		417
		418	=item B<-embed> I<windowid>
		419
		420	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
		421	which enables applications to easily embed a terminal.
		422
		423	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		424	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		425	quite a bit, so don't expect it to keep some specific state. It's best to
		426	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		427
		428	The window will not be destroyed when @@RXVT_NAME@@ exits.
		429
		430	It might be useful to know that @@RXVT_NAME@@ will not close file
		431	descriptors passed to it (except for stdin/out/err, of course), so you
		432	can use file descriptors to communicate with the programs within the
		433	terminal. This works regardless of wether the C<-embed> option was used or
		434	not.
		435
		436	Here is a short Gtk2-perl snippet that illustrates how this option can be
		437	used (a longer example is in F<doc/embed>):
		438
		439	my $rxvt = new Gtk2::Socket;
		440	$rxvt->signal_connect_after (realize => sub {
		441	my $xid = $_[0]->window->get_xid;
		442	system "@@RXVT_NAME@@ -embed $xid &";
		443	});
		444
		445	=item B<-pty-fd> I<file descriptor>
		446
		447	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		448	pair but instead use the given filehandle as the tty master. This is
		449	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		450	without having to run a program within it.
		451
		452	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		453	entries and will not tinker with pty/tty permissions - you have to do that
		454	yourself if you want that.
		455
		456	As an extremely special case, specifying C<-1> will completely suppress
		457	pty/tty operations.
		458
		459	Here is a example in perl that illustrates how this option can be used (a
		460	longer example is in F<doc/pty-fd>):
		461
		462	use IO::Pty;
		463	use Fcntl;
		464
		465	my $pty = new IO::Pty;
		466	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		467	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		468	close $pty;
		469
		470	# now communicate with rxvt
		471	my $slave = $pty->slave;
		472	while (<$slave>) { print $slave "got <$_>\n" }
		473
326	=item B<-xrm> I<resourcestring>	474	=item B<-pe> I<string>
327		475
328	No effect on rxvt-unicode. Simply passes through an argument to be made	476	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	477	this terminal instance. See resource B<perl-ext> for details.
330	some window managers.
331		478
332	=back	479	=back
333		480
334	=head1 RESOURCES (available also as long-options)	481	=head1 RESOURCES (available also as long-options)
335		482
336	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	483	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
337	options) compiled into your version.	484	options) compiled into your version.
338		485
339	There are two different methods that @@RXVT_NAME@@ can use to get the	486	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	487	distribution do also load settings from the B<~/.Xresources> file when X
341	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	488	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	489	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		490
346	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	491	1. system-wide app-defaults file, either locale-dependent OR global
347	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	492	2. app-defaults file in $XAPPLRESDIR
348	set in XAPPLOADDIR/URxvt (compile-time defined: usually	493	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
349	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	494	4. SCREEN_RESOURCES for the current screen
350	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	495	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		496
351	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	497	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	498	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	499	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	500	configured, while the class name B<URxvt> allows resources unique to
355	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	501	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
356	shared between different B<@@RXVT_NAME@@> configurations. If no	502	configurations. If no resources are specified, suitable defaults will
357	resources are specified, suitable defaults will be used. Command-line	503	be used. Command-line arguments can be used to override resource
358	arguments can be used to override resource settings. The following	504	settings. The following resources are supported (you might want to
359	resources are allowed:	505	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		506	extensions not documented here):
360		507
361	=over 4	508	=over 4
362		509
363	=item B<geometry:> I<geom>	510	=item B<geometry:> I<geom>
364		511
…		…
382	high-intensity (bold = bright foreground, blink = bright background)	529	high-intensity (bold = bright foreground, blink = bright background)
383	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	530	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	531	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.	532	names used are listed in the B<COLORS AND GRAPHICS> section.
386		533
		534	Colours higher than 15 cannot be set using resources (yet), but can be
		535	changed using an escape command (see @@RXVT_NAME@@(7)).
		536
		537	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		538	88 colour support). Colours 80-87 are evenly spaces grey steps.
		539
387	=item B<colorBD:> I<colour>	540	=item B<colorBD:> I<colour>
388		541
		542	=item B<colorIT:> I<colour>
		543
389	Use the specified colour to display bold characters when the foreground	544	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	545	foreground colour is the default. If font styles are not available
391	enabled.	546	(Compile I<styles>) and this option is unset, reverse video is used instead.
392		547
393	=item B<colorUL:> I<colour>	548	=item B<colorUL:> I<colour>
394		549
395	Use the specified colour to display underlined characters when the	550	Use the specified colour to display underlined characters when the
396	foreground colour is the default.	551	foreground colour is the default.
397		552
398	=item B<colorRV:> I<colour>	553	=item B<colorRV:> I<colour>
399		554
400	Use the specified colour as the background for reverse video	555	Use the specified colour as the background for reverse video
401	characters.	556	characters.
		557
		558	=item B<underlineColor:> I<colour>
		559
		560	If set, use the specified colour as the colour for the underline
		561	itself. If unset, use the foreground colour.
402		562
403	=item B<cursorColor:> I<colour>	563	=item B<cursorColor:> I<colour>
404		564
405	Use the specified colour for the cursor. The default is to use the	565	Use the specified colour for the cursor. The default is to use the
406	foreground colour; option B<-cr>.	566	foreground colour; option B<-cr>.
…		…
429	artificial transparency. B<False>: do not inherit the parent windows'	589	artificial transparency. B<False>: do not inherit the parent windows'
430	pixmap.	590	pixmap.
431		591
432	=item B<fading:> I<number>	592	=item B<fading:> I<number>
433		593
434	Fade the text by the given percentage when focus is lost.	594	Fade the text by the given percentage when focus is lost; option B<-fade>.
		595
		596	=item B<fadeColor:> I<colour>
		597
		598	Fade to this colour, when fading is used (see B<fading:>). The default
		599	colour is black; option B<-fadecolor>.
435		600
436	=item B<tintColor:> I<colour>	601	=item B<tintColor:> I<colour>
437		602
438	Tint the transparent background pixmap with the given colour.	603	Tint the transparent background pixmap with the given colour; option
		604	B<-tint>.
439		605
440	=item B<shading:> I<number>	606	=item B<shading:> I<number>
441		607
442	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	608	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
443	image in addition to tinting it.	609	image in addition to tinting it.
444		610
445	=item B<fading:> I<number>
446
447	Scale the tint colour by the given percentage.
448
449	=item B<scrollColor:> I<colour>	611	=item B<scrollColor:> I<colour>
450		612
451	Use the specified colour for the scrollbar [default #B2B2B2].	613	Use the specified colour for the scrollbar [default #B2B2B2].
452		614
453	=item B<troughColor:> I<colour>	615	=item B<troughColor:> I<colour>
454		616
455	Use the specified colour for the scrollbar's trough area [default	617	Use the specified colour for the scrollbar's trough area [default
456	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	618	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
		619
		620	=item B<borderColor:> I<colour>
		621
		622	The colour of the border around the text area and between the scrollbar
		623	and the text.
457		624
458	=item B<backgroundPixmap:> I<file[;geom]>	625	=item B<backgroundPixmap:> I<file[;geom]>
459		626
460	Use the specified XPM file (note the `.xpm' extension is optional) for	627	Use the specified XPM file (note the `.xpm' extension is optional) for
461	the background and also optionally specify its scaling with a geometry	628	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	632	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	633	specifies an integer number of images in that direction. No image will
467	be magnified beyond 10 times its original size. The maximum permitted	634	be magnified beyond 10 times its original size. The maximum permitted
468	scale is 1000. [default 0x0+50+50]	635	scale is 1000. [default 0x0+50+50]
469		636
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>	637	=item B<path:> I<path>
477		638
478	Specify the colon-delimited search path for finding files (XPM and	639	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		640
482	=item B<font:> I<fontname>	641	=item B<font:> I<fontlist>
483		642
484	Select the fonts to be used. This is a comma seperated list of font	643	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.	644	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	645	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	646	smaller, but not (in general) larger. A (hopefully) reasonable default
488	appended to it. option B<-fn>.	647	font list is always appended to it; option B<-fn>.
489		648
490	=item B<realBold:> I<boolean>	649	Each font can either be a standard X11 core font (XLFD) name, with
		650	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
491		651
492	B<True>: Enable "real bold" support. When this option is on, bold text	652	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.	653	specifications enclosed in square brackets (C<[]>). The only available
494	Bold fonts should thus be specified in the font list after their	654	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	655	fonts.
496	font will be used. option B<-rb>. B<False>: Display bold text in a	656
497	regular font, using the color specified with B<colorBD>; option B<+rb>.	657	For example, this font resource
		658
		659	URxvt.font: 9x15bold,\
		660	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		661	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		662	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		663	xft:Code2000:antialias=false
		664
		665	specifies five fonts to be used. The first one is C<9x15bold> (actually
		666	the iso8859-1 version of the second font), which is the base font (because
		667	it is named first) and thus defines the character cell grid to be 9 pixels
		668	wide and 15 pixels high.
		669
		670	The second font is just used to add additional unicode characters not in
		671	the base font, likewise the third, which is unfortunately non-bold, but
		672	the bold version of the font does contain less characters, so this is a
		673	useful supplement.
		674
		675	The third font is an Xft font with aliasing turned off, and the characters
		676	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		677	contains other characters, but we are not interested in them.
		678
		679	The last font is a useful catch-all font that supplies most of the
		680	remaining unicode characters.
		681
		682	=item B<boldFont:> I<fontlist>
		683
		684	=item B<italicFont:> I<fontlist>
		685
		686	=item B<boldItalicFont:> I<fontlist>
		687
		688	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		689	italic> >> characters, respectively.
		690
		691	If specified and non-empty, then the syntax is the same as for the
		692	B<font>-resource, and the given font list will be used as is, which makes
		693	it possible to substitute completely different font styles for bold and
		694	italic.
		695
		696	If unset (the default), a suitable font list will be synthesized by
		697	"morphing" the normal text font list into the desired shape. If that is
		698	not possible, replacement fonts of the desired shape will be tried.
		699
		700	If set, but empty, then this specific style is disabled and the normal
		701	text font will being used for the given style.
		702
		703	=item B<intensityStyles:> I<boolean>
		704
		705	When font styles are not enabled, or this option is enabled (B<True>,
		706	option B<-is>, the default), bold and italic font styles imply high
		707	intensity foreground/backround colours. Disabling this option (B<False>,
		708	option B<+is>) disables this behaviour, the high intensity colours are not
		709	reachable.
498		710
499	=item B<selectstyle:> I<mode>	711	=item B<selectstyle:> I<mode>
500		712
501	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	713	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	714	xterm style with 2.20 old word selection, or anything else which gives
503	xterm style selection.	715	xterm style selection.
504		716
505	=item B<scrollstyle:> I<mode>	717	=item B<scrollstyle:> I<mode>
506		718
507	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	719	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
508	the author's favourite..	720	the author's favourite.
509		721
510	=item B<title:> I<string>	722	=item B<title:> I<string>
511		723
512	Set window title string, the default title is the command-line	724	Set window title string, the default title is the command-line
513	specified after the B<-e> option, if any, otherwise the application	725	specified after the B<-e> option, if any, otherwise the application
…		…
545		757
546	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	758	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	759	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.	760	B<Shift-Print> to include the scrollback as well.
549		761
		762	The string will be interpreted as if typed into the shell as-is.
		763
		764	Example:
		765
		766	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		767
		768	This creates a new file in your home directory with the screen contents
		769	everytime you hit C<Print>.
		770
550	=item B<scrollBar:> I<boolean>	771	=item B<scrollBar:> I<boolean>
551		772
552	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	773	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
553	disable the scrollbar; option B<+sb>.	774	disable the scrollbar; option B<+sb>.
554		775
…		…
573	B<False>: do not scroll to bottom when tty receives output; option	794	B<False>: do not scroll to bottom when tty receives output; option
574	B<+si>.	795	B<+si>.
575		796
576	=item B<scrollWithBuffer:> I<boolean>	797	=item B<scrollWithBuffer:> I<boolean>
577		798
578	B<True>: scroll with scrollback buffer when tty recieves new lines (and	799	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	800	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
580	with scrollback buffer when tty recieves new lines; option B<-sw>.	801	with scrollback buffer when tty recieves new lines; option B<+sw>.
581		802
582	=item B<scrollTtyKeypress:> I<boolean>	803	=item B<scrollTtyKeypress:> I<boolean>
583		804
584	B<True>: scroll to bottom when a non-special key is pressed. Special keys	805	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	806	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	807	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>.	808	bottom when a non-special key is pressed; option B<+sk>.
588		809
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>	810	=item B<saveLines:> I<number>
600		811
601	Save I<number> lines in the scrollback buffer [default 64]. This	812	Save I<number> lines in the scrollback buffer [default 64]. This
602	resource is limited on most machines to 65535; option B<-sl>.	813	resource is limited on most machines to 65535; option B<-sl>.
603		814
…		…
614	=item B<borderLess:> I<boolean>	825	=item B<borderLess:> I<boolean>
615		826
616	Set MWM hints to request a borderless window, i.e. if honoured by the	827	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>.	828	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
618		829
		830	=item B<skipBuiltinGlyphs:> I<boolean>
		831
		832	Compile I<frills>: Disable the usage of the built-in block graphics/line
		833	drawing characters and just rely on what the specified fonts provide. Use
		834	this if you have a good font and want to use its block graphic glyphs;
		835	option B<-sbg>.
		836
619	=item B<termName:> I<termname>	837	=item B<termName:> I<termname>
620		838
621	Specifies the terminal type name to be set in the B<TERM> environment	839	Specifies the terminal type name to be set in the B<TERM> environment
622	variable; option B<-tn>.	840	variable; option B<-tn>.
623		841
…		…
633		851
634	=item B<mouseWheelScrollPage:> I<boolean>	852	=item B<mouseWheelScrollPage:> I<boolean>
635		853
636	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	854	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
637	scrolls five lines [default].	855	scrolls five lines [default].
		856
		857	=item B<pastableTabs:> I<boolean>
		858
		859	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		860	movement only; option C<-ptab>.
638		861
639	=item B<cursorBlink:> I<boolean>	862	=item B<cursorBlink:> I<boolean>
640		863
641	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	864	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
642	option B<-bc>.	865	option B<-bc>.
…		…
655		878
656	Mouse pointer background colour.	879	Mouse pointer background colour.
657		880
658	=item B<pointerBlankDelay:> I<number>	881	=item B<pointerBlankDelay:> I<number>
659		882
660	Specifies number of seconds before blanking the pointer [default 2].	883	Specifies number of seconds before blanking the pointer [default 2]. Use a
		884	large number (e.g. C<987654321>) to effectively disable the timeout.
661		885
662	=item B<backspacekey:> I<string>	886	=item B<backspacekey:> I<string>
663		887
664	The string to send when the backspace key is pressed. If set to B<DEC>	888	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>	889	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	896	pressed. If unset it will send the sequence traditionally associated
673	with the B<Execute> key.	897	with the B<Execute> key.
674		898
675	=item B<cutchars:> I<string>	899	=item B<cutchars:> I<string>
676		900
677	The characters used as delimiters for double-click word selection. The	901	The characters used as delimiters for double-click word selection.
678	built-in default:	902
		903	When the selection extension is in use (the default if compiled in, see
		904	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
		905	will be created (if the resource exists, otherwise, no regex will be
		906	created). In this mode, characters outside ISO-8859-1 can be used.
		907
		908	When the selection extension is not used, only ISO-8859-1 characters can
		909	be used. If not specified, the built-in default is used:
679		910
680	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	911	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
681		912
682	=item B<preeditType:> I<style>	913	=item B<preeditType:> I<style>
683		914
…		…
687		918
688	I<name> of inputMethod to use; option B<-im>.	919	I<name> of inputMethod to use; option B<-im>.
689		920
690	=item B<imLocale:> I<name>	921	=item B<imLocale:> I<name>
691		922
692	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	923	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	924	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	925	input extension to be able to input japanese characters while staying in
695	another locale. option B<-imlocale>.	926	another locale; option B<-imlocale>.
696		927
697	=item B<insecure>	928	=item B<imFont:> I<fontset>
		929
		930	Specify the font-set used for XIM styles C<OverTheSpot> or
		931	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		932	by commas), i.e. it's not in the same format as the other font lists used
		933	in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
		934	found, preferably one or two pixels differing in size to the base font.
		935	option B<-imfont>.
		936
		937	=item B<tripleclickwords:> I<boolean>
		938
		939	Change the meaning of triple-click selection with the left mouse
		940	button. Instead of selecting a full line it will extend the selection to
		941	the end of the logical line only; option B<-tcw>.
		942
		943	=item B<insecure:> I<boolean>
698		944
699	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	945	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
700	echo arbitrary strings like the icon name or the locale. This could be	946	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	947	abused if somebody gets 8-bit-clean access to your display, whether
702	throuh a mail client displaying mail bodies unfiltered or though	948	through a mail client displaying mail bodies unfiltered or through
703	write(1). Therefore, these sequences are disabled by default. (Note	949	write(1) or any other means. Therefore, these sequences are disabled by
704	that other terminals, including xterm, have these sequences	950	default. (Note that many other terminals, including xterm, have these
705	enabled by default). You can enable them by setting this boolean	951	sequences enabled by default, which doesn't make it safer, though).
706	resource or specifying B<-insecure> as an option. At the moment, this	952
707	enabled display-answer, locale, findfont, icon label and window title	953	You can enable them by setting this boolean resource or specifying
708	requests as well as dynamic menubar dispatch.	954	B<-insecure> as an option. At the moment, this enables display-answer,
		955	locale, findfont, icon label and window title requests.
709		956
710	=item B<modifier:> I<modifier>	957	=item B<modifier:> I<modifier>
711		958
712	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	959	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	960	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
717		964
718	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	965	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	966	character is passed through. It may contain escape values as described
720	in the entry on B<keysym> following.	967	in the entry on B<keysym> following.
721		968
722	=item B<secondaryScreen:> I<bool>	969	=item B<secondaryScreen:> I<boolean>
723		970
724	Turn on/off secondary screen (default enabled).	971	Turn on/off secondary screen (default enabled).
725		972
726	=item B<secondaryScroll:> I<bool>	973	=item B<secondaryScroll:> I<boolean>
727		974
728	Turn on/off secondary screen scroll (default enabled). If the this	975	Turn on/off secondary screen scroll (default enabled). If the this
729	option is enabled, scrolls on the secondary screen will change the	976	option is enabled, scrolls on the secondary screen will change the
730	scrollback buffer and switching to/from the secondary screen will	977	scrollback buffer and switching to/from the secondary screen will
731	instead scroll the screen up.	978	instead scroll the screen up.
732		979
		980	=item B<hold>: I<boolean>
		981
		982	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		983	will not immediately destroy its window when the program executed within
		984	it exits. Instead, it will wait till it is being killed or closed by the
		985	user.
		986
733	=item B<keysym.>I<sym>: I<string>	987	=item B<keysym.>I<sym>: I<string>
734		988
735	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	989	Compile I<frills>: Associate I<string> with keysym I<sym>. The
736	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	990	intervening resource name B<keysym.> cannot be omitted.
737	newline, \r: return, \t:	991
		992	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		993	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		994	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		995	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		996	B<2>, B<3>, B<4>, B<5>.
		997
		998	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		999	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1000	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1001	current application keymap mode state.
		1002
		1003	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1004	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1005	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1006	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1007	performed in an exact manner; however, the closest match is assured.
		1008
		1009	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		1010	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,	1011	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	1012	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	1013	can start or end with whitespace.
741	omitted. This resource is only available when compiled with	1014
742	KEYSYM_RESOURCE.	1015	Please note that you need to double the C<\> in resource files, as
		1016	Xlib itself does it's own de-escaping (you can use C<\033> instead of
		1017	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
		1018	processing).
		1019
		1020	You can define a range of keysyms in one shot by providing a I<string>
		1021	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
		1022	should be a character not used by the strings.
		1023
		1024	Its usage can be demonstrated by an example:
		1025
		1026	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
		1027
		1028	The above line is equivalent to the following three lines:
		1029
		1030	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1031	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1032	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1033
		1034	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1035	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1036	example the following means "change the current locale to C<zh_CN.GBK>
		1037	when Control-Meta-c is being pressed":
		1038
		1039	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1040
		1041	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1042	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1043	manpage. For example, the F<selection> extension (activated via
		1044	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1045
		1046	URxvt.keysym.M-C-c: perl:selection:rot13
		1047
		1048	Due the the large number of modifier combinations, a defined key mapping
		1049	will match if at I<at least> the specified identifiers are being set, and
		1050	no other key mappings with those and more bits are being defined. That
		1051	means that defining a key map for C<a> will automatically provide
		1052	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1053	mappings themselves.
		1054
		1055	Unfortunately, this will override built-in key mappings. For example
		1056	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1057	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1058	user-defined keymap using the C<builtin:> replacement:
		1059
		1060	URxvt.keysym.Insert: <my insert key sequence>
		1061	URxvt.keysym.S-Insert: builtin:
		1062
		1063	The first line defines a mapping for C<Insert> and I<any> combination
		1064	of modifiers. The second line re-establishes the default mapping for
		1065	C<Shift-Insert>.
		1066
		1067	The following example will map Control-Meta-1 and Control-Meta-2 to
		1068	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1069	font-switching at runtime:
		1070
		1071	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1072	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1073
		1074	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1075	info):
		1076
		1077	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1078	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1079
		1080	=item B<perl-ext-common>: I<string>
		1081
		1082	=item B<perl-ext>: I<string>
		1083
		1084	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1085	use in this terminal instance; option B<-pe>.
		1086
		1087	Extension names can be prefixed with a C<-> sign to prohibit using
		1088	them. This can be useful to selectively disable some extensions loaded
		1089	by default, or specified via the C<perl-ext-common> resource. For
		1090	example, C<default,-selection> will use all the default extension except
		1091	C<selection>.
		1092
		1093	Extension names can also be followed by an argument in angle brackets
		1094	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1095	searchable scorllback to Alt/Meta-s). Mentioning the same extension
		1096	multiple times with different arguments will pass multiple arguments to
		1097	the extension.
		1098
		1099	Each extension is looked up in the library directories, loaded if
		1100	necessary, and bound to the current terminal instance.
		1101
		1102	If both of these resources are the empty string, then the perl
		1103	interpreter will not be initialized. The idea behind two options is that
		1104	B<perl-ext-common> will be used for extensions that should be available to
		1105	all instances, while B<perl-ext> is used for specific instances.
		1106
		1107	=item B<perl-eval>: I<string>
		1108
		1109	Perl code to be evaluated when all extensions have been registered. See
		1110	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1111	will be ignored when running setuid/setgid.
		1112
		1113	=item B<perl-lib>: I<path>
		1114
		1115	Colon-separated list of additional directories that hold extension
		1116	scripts. When looking for extensions specified by the C<perl> resource,
		1117	@@RXVT_NAME@@ will first look in these directories and then in
		1118	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1119	will be ignored when running setuid/setgid.
		1120
		1121	See the @@RXVT_NAME@@perl(3) manpage.
		1122
		1123	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1124
		1125	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1126	details.
		1127
		1128	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1129
		1130	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1131	for details.
		1132
		1133	=item B<searchable-scrollback:> I<keysym>
		1134
		1135	Sets the hotkey that starts the incremental scrollback buffer search
		1136	(default: C<M-s>).
		1137
		1138	=item B<urlLauncher>: I<string>
		1139
		1140	Specifies the program to be started with a URL argument. Used by the
		1141	C<selection-popup> and C<mark-urls> perl extensions.
		1142
		1143	=item B<transient-for>: I<windowid>
		1144
		1145	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1146
		1147	=item B<override-redirect>: I<boolean>
		1148
		1149	Compile I<frills>: Sets override-redirect for the terminal window, making
		1150	it almost invisible to window managers; option B<-override-redirect>.
743		1151
744	=back	1152	=back
745		1153
746	=head1 THE SCROLLBAR	1154	=head1 THE SCROLLBAR
747		1155
…		…
761	the normal text selection/insertion, hold either the Shift or the Meta	1169	the normal text selection/insertion, hold either the Shift or the Meta
762	(Alt) key while performing the desired mouse action.	1170	(Alt) key while performing the desired mouse action.
763		1171
764	If mouse reporting mode is active, the normal scrollbar actions are	1172	If mouse reporting mode is active, the normal scrollbar actions are
765	disabled -- on the assumption that we are using a fullscreen	1173	disabled -- on the assumption that we are using a fullscreen
766	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1174	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
767	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1175	(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),	1176	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
769	respectively.	1177	respectively.
770		1178
771	=head1 TEXT SELECTION AND INSERTION	1179	=head1 TEXT SELECTION AND INSERTION
772		1180
773	The behaviour of text selection and insertion mechanism is similar to	1181	The behaviour of text selection and insertion mechanism is similar to
…		…
775		1183
776	=over 4	1184	=over 4
777		1185
778	=item B<Selection>:	1186	=item B<Selection>:
779		1187
780	Left click at the beginning of the region, drag to the end of the	1188	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	1189	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	1190	to select a word; Left triple-click to select the entire logical line
783	line.	1191	(which can span multiple screen lines), unless modified by resource
		1192	B<tripleclickwords>.
		1193
		1194	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1195	(Compile: I<frills>) will create a rectangular selection instead of a
		1196	normal one. In this mode, every selected row becomes its own line in the
		1197	selection, and trailing whitespace is visually underlined and removed from
		1198	the selection.
784		1199
785	=item B<Insertion>:	1200	=item B<Insertion>:
786		1201
787	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1202	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	1203	window causes the value of the PRIMARY selection (or CLIPBOARD with the
789	inserted as if it had been typed on the keyboard.	1204	Meta modifier) to be inserted as if it had been typed on the keyboard.
		1205
		1206	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1207	inserted too.
790		1208
791	=back	1209	=back
792		1210
793	=head1 CHANGING FONTS	1211	=head1 CHANGING FONTS
794		1212
795	You can change fonts on-the-fly, which is to say cycle through the	1213	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	1214	supported in rxvt-unicode. Bug me if you need this.
797	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1215
798	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1216	You can, however, switch fonts at runtime using escape sequences, e.g.:
799	actual key can be selected using resources	1217
800	B<smallfont_key>/B<bigfont_key>.	1218	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1219
		1220	You can use keyboard shortcuts, too:
		1221
		1222	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1223	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
		1224
		1225	rxvt-unicode will automatically re-apply these fonts to the output so far.
801		1226
802	=head1 ISO 14755 SUPPORT	1227	=head1 ISO 14755 SUPPORT
803		1228
804	Partial ISO 14755-support is implemented. that means that pressing	1229	ISO 14755 is a standard for entering and viewing unicode characters
		1230	and character codes using the keyboard. It consists of 4 parts. The
		1231	first part is available rxvt-unicode has been compiled with
		1232	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1233	with C<--enable-iso14755>.
805		1234
806	Section 5.1: Control and Shift together enters unicode input	1235	=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		1236
811	Section 5.2: Pressing and immediately releasing Control and Shift together	1237	=item * 5.1: Basic method
812	enters keycap entry mode for the next key: pressing a function key (tab,	1238
813	return etc..) will enter the unicode character corresponding to the given	1239	This allows you to enter unicode characters using their hexcode.
814	key.	1240
		1241	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1242	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1243	commit the character as if it were typed directly. While holding down
		1244	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1245	C<Space>, which will commit the current character and lets you start a new
		1246	one.
		1247
		1248	As an example of use, imagine a business card with a japanese e-mail
		1249	address, which you cannot type. Fortunately, the card has the e-mail
		1250	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1251	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1252	followed by releasing the modifier keys.
		1253
		1254	=item * 5.2: Keyboard symbols entry method
		1255
		1256	This mode lets you input characters representing the keycap symbols of
		1257	your keyboard, if representable in the current locale encoding.
		1258
		1259	Start by pressing C<Control> and C<Shift> together, then releasing
		1260	them. The next special key (cursor keys, home etc.) you enter will not
		1261	invoke it's usual function but instead will insert the corresponding
		1262	keycap symbol. The symbol will only be entered when the key has been
		1263	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1264	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1265	reverse tab (Shift-Tab).
		1266
		1267	=item * 5.3: Screen-selection entry method
		1268
		1269	While this is implemented already (it's basically the selection
		1270	mechanism), it could be extended by displaying a unicode character map.
		1271
		1272	=item * 5.4: Feedback method for identifying displayed characters for later input
		1273
		1274	This method lets you display the unicode character code associated with
		1275	characters already displayed.
		1276
		1277	You enter this mode by holding down C<Control> and C<Shift> together, then
		1278	pressing and holding the left mouse button and moving around. The unicode
		1279	hex code(s) (it might be a combining character) of the character under the
		1280	pointer is displayed until you release C<Control> and C<Shift>.
		1281
		1282	In addition to the hex codes it will display the font used to draw this
		1283	character - due to implementation reasons, characters combined with
		1284	combining characters, line drawing characters and unknown characters will
		1285	always be drawn using the built-in support font.
		1286
		1287	=back
		1288
		1289	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1290	both scenario A and B of ISO 14755, including part 5.2.
815		1291
816	=head1 LOGIN STAMP	1292	=head1 LOGIN STAMP
817		1293
818	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1294	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.	1295	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	1296	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
821	some systems.	1297	on some systems or setgid to root or to some other group on others.
822		1298
823	=head1 COLORS AND GRAPHICS	1299	=head1 COLORS AND GRAPHICS
824		1300
825	In addition to the default foreground and background colours,	1301	In addition to the default foreground and background colours,
826	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1302	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
…		…
867	would yield White on Black, while on I<xterm>(1) it would yield Black	1343	would yield White on Black, while on I<xterm>(1) it would yield Black
868	on White.	1344	on White.
869		1345
870	=back	1346	=back
871		1347
872	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1348	=head1 ENVIRONMENT
		1349
		1350	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
873		1351
874	=over 4	1352	=over 4
875		1353
876	=item How do I know which rxvt-unicode version I'm using?	1354	=item B<TERM>
877		1355
878	The version number is displayed with the usage (-h). For rxvt-unicode	1356	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	1357	resources or on the commandline.
880	title to the version number.
881		1358
882	=item Why do the characters look ugly?	1359	=item B<COLORTERM>
883		1360
884	=item How does rxvt-unicode choose fonts?	1361	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
		1362	compiled with XPM support, and optionally with the added extension
		1363	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
885		1364
886	Most fonts do not contain the full range of Unicode, which is	1365	=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		1366
891	B<rxvt-unicode> makes a best-effort try at finding a replacement	1367	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	1368	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	1369	C<default> to indicate that the default-colour escape sequence is to be
894	list, e.g.:	1370	used), C<bg> is the colour code used as default background colour (or the
		1371	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1372	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1373	(and do) use this information to optimize screen output.
895		1374
896	@@RXVT_NAME@@ -fn basefont,font2,font3...	1375	=item B<WINDOWID>
897		1376
898	When rxvt-unicode sees a character, it will first look at the base	1377	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	1378	window, which usually has subwindows for the scrollbar, the terminal
900	next font, and so on.	1379	window and so on).
901		1380
902	The only limitation is that all the fonts must not be larger than the base	1381	=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		1382
906	=item Why do some chinese characters look so different than others?	1383	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1384	C<--with-terminfo=PATH>.
907		1385
908	This is because there is a difference between script and language --	1386	=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		1387
918	The workaround is easy: just tag a chinese font at the end of your font	1388	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	1389	display in it's 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		1390
923	In the future it might be possible to switch preferences at runtime (the	1391	=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		1392
928	=item Mouse cut/paste suddenly no longer works.	1393	The shell to be used for command execution, defaults to C</bin/sh>.
929		1394
930	Make sure that mouse reporting is actually turned off since killing	1395	=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		1396
936	=item What's with this bold/blink stuff?	1397	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1398	@@RXVT_NAME@@d(1).
937		1399
938	If no bold colour is set via C<colorBD:>, bold will invert text using the	1400	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
939	standard foreground colour.
940		1401
941	For the standard background colour, blinking will actually make the	1402	=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		1403
946	On ANSI colours, bold/blink attributes are used to set high-intensity	1404	Used to locate the default directory for the unix domain socket for
947	foreground/background colors.	1405	daemon communications and to locate various resource files (such as
		1406	C<.Xdefaults>)
948		1407
949	color0-7 are the low-intensity colors.	1408	=item B<XAPPLRESDIR>
950		1409
951	color8-15 are the corresponding high-intensity colors.	1410	Directory where various X resource files are being located.
952		1411
953	=item I don't like the screen colors. How do I change them?	1412	=item B<XENVIRONMENT>
954		1413
955	You can change the screen colors at run-time using F<~/.Xdefaults>	1414	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@@	1415	@@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		1416
1137	=back	1417	=back
1138		1418
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	1419	=head1 FILES
1149		1420
1150	=over 4	1421	=over 4
1151		1422
1152	=item B</etc/utmp>
1153
1154	System file for login records.
1155
1156	=item B</usr/lib/X11/rgb.txt>	1423	=item B</usr/lib/X11/rgb.txt>
1157		1424
1158	Color names.	1425	Color names.
1159		1426
1160	=back	1427	=back
1161		1428
1162	=head1 SEE ALSO	1429	=head1 SEE ALSO
1163		1430
1164	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1431	@@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		1432
1174	=head1 CURRENT PROJECT COORDINATOR	1433	=head1 CURRENT PROJECT COORDINATOR
1175		1434
1176	=over 4	1435	=over 4
1177		1436
1178	=item Project Coordinator	1437	=item Project Coordinator
1179		1438
1180	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1439	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1181		1440
1182	=item Web page maintainter	1441	L<http://software.schmorp.de/#rxvt-unicode>
1183
1184	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1185
1186	L<@@RXVT_WEBPAGE@@>
1187		1442
1188	=back	1443	=back
1189		1444
1190	=head1 AUTHORS	1445	=head1 AUTHORS
1191		1446
…		…
1213		1468
1214	Project Coordinator (changes.txt 2.21a to 2.4.5)	1469	Project Coordinator (changes.txt 2.21a to 2.4.5)
1215		1470
1216	=item Geoff Wing L<< <gcw@pobox.com> >>	1471	=item Geoff Wing L<< <gcw@pobox.com> >>
1217		1472
1218	Rewrote screen display and text selection routines. Project Coordinator	1473	Rewrote screen display and text selection routines.
		1474
1219	(changes.txt 2.4.6 - rxvt-unicode)	1475	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1220		1476
1221	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1477	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1222		1478
1223	Forked rxvt-unicode, rewrote most of the display code and internal	1479	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1224	character handling to store text in unicode, improve xterm	1480	extension, random hacks, numerous bugfixes and extensions.
1225	compatibility and apply numerous other bugfixes and extensions.
1226		1481
1227	Project Coordinator (Changes 1.0 -)	1482	Project Coordinator (Changes 1.0 -)
1228		1483
		1484	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1485
		1486	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1487
1229	=back	1488	=back
1230		1489

Diff Legend

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