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.4 by root, Fri Aug 13 03:47:09 2004 UTC vs.
Revision 1.107 by root, Sun Jan 29 20:51:27 2006 UTC

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

Diff Legend

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