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.3 by root, Thu Aug 12 22:22:30 2004 UTC vs.
Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 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/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 right-to-left 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 user friendly, 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 its 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	its predecessor, supports things such as XFT and ISO 14755 that are handy
		52	in i18n-environments, is faster, and has a lot bugs less 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 its 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) more 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<xft>: 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
		120	I<Please note that transparency of any kind if completely unsupported by
		121	the author. Don't bug him with installation questions! Read the FAQ (man 7
		122	@@RXVT_NAME@@)!>
		123
68	=item B<-fade> I<number>	124	=item B<-fade> I<number>
69		125
70	Fade the text by the given percentage when focus is lost.	126	Fade the text by the given percentage when focus is lost. Small values
		127	fade a little only, 100 completely replaces all colours by the fade
		128	colour; resource B<fading>.
		129
		130	=item B<-fadecolor> I<colour>
		131
		132	Fade to this colour when fading is used (see B<-fade>). The default colour
		133	is opaque black. resource B<fadeColor>.
71		134
72	=item B<-tint> I<colour>	135	=item B<-tint> I<colour>
73		136
74	Tint the transparent background pixmap with the given colour when	137	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>	138	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	139	non-tiled backgrounds, currently. See also the B<-sh> option that can be
77	tinting it.	140	used to brighten or darken the image in addition to tinting it; resource
		141	I<tintColor>. Example:
78		142
79	=item B<-sh>	143	@@RXVT_NAME@@ -tr -tint blue -sh 40
80		144
		145	=item B<-sh> I<number>
		146
81	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	147	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
82	background image in addition to tinting it (i.e. B<-tint> must be	148	background image in addition to (or instead of) tinting it;
83	specified, too).	149	resource I<shading>.
		150
		151	=item B<-blt> I<string>
		152
		153	Specify background blending type. If background pixmap is specified
		154	at the same time as transparency - such pixmap will be blended over
		155	transparency image, using method specified. Supported values are :
		156	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		157	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		158	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		159	alpha-blending; resource I<blendType>.
		160
		161	=item B<-blr> I<number>
		162
		163	Apply Gaussian Blur with the specified radius to the transparent
		164	background image; resource I<blurRadius>.
84		165
85	=item B<-bg> I<colour>	166	=item B<-bg> I<colour>
86		167
87	Window background colour; resource B<background>.	168	Window background colour; resource B<background>.
88		169
…		…
90		171
91	Window foreground colour; resource B<foreground>.	172	Window foreground colour; resource B<foreground>.
92		173
93	=item B<-pixmap> I<file[;geom]>	174	=item B<-pixmap> I<file[;geom]>
94		175
95	Compile I<XPM>: Specify XPM file for the background and also optionally	176	Compile I<afterimage>: Specify image file for the background and also
96	specify its scaling with a geometry string. Note you may need to add	177	optionally specify its scaling with a geometry string. Note you may need to
97	quotes to avoid special shell interpretation of the `;' in the	178	add quotes to avoid special shell interpretation of the C<;> in the
98	command-line; resource B<backgroundPixmap>.	179	command-line; for more details see resource B<backgroundPixmap>.
99		180
100	=item B<-cr> I<colour>	181	=item B<-cr> I<colour>
101		182
102	The cursor colour; resource B<cursorColor>.	183	The cursor colour; resource B<cursorColor>.
103		184
…		…
109		190
110	The mouse pointer background colour; resource B<pointerColor2>.	191	The mouse pointer background colour; resource B<pointerColor2>.
111		192
112	=item B<-bd> I<colour>	193	=item B<-bd> I<colour>
113		194
114	The colour of the border between the xterm scrollbar and the text;	195	The colour of the border around the text area and between the scrollbar and the text;
115	resource B<borderColor>.	196	resource B<borderColor>.
116		197
117	=item B<-fn> I<fontname>	198	=item B<-fn> I<fontlist>
118		199
119	Select the fonts to be used. This is a comma seperated list of font	200	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.	201	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	202	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	203	smaller, but not (in general) larger. A (hopefully) reasonable default
123	appended to it. resource B<font>.	204	font list is always appended to it. See resource B<font> for more details.
124		205
		206	In short, to specify an X11 core font, just specify its name or prefix it
		207	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		208	e.g.:
		209
		210	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		211	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
		212
		213	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
		214	section of @@RXVT_NAME@@(7).
		215
		216	=item B<-fb> I<fontlist>
		217
		218	Compile I<font-styles>: The bold font list to use when B<bold> characters
		219	are to be printed. See resource B<boldFont> for details.
		220
		221	=item B<-fi> I<fontlist>
		222
		223	Compile I<font-styles>: The italic font list to use when I<italic>
		224	characters are to be printed. See resource B<italicFont> for details.
		225
		226	=item B<-fbi> I<fontlist>
		227
		228	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
		229	italic> >> characters are to be printed. See resource B<boldItalicFont>
		230	for details.
		231
125	=item B<-rb>|B<+rb>	232	=item B<-is>|B<+is>
126		233
127	Enable "real bold" support. When this option is on, bold text will be	234	Compile I<font-styles>: Bold/Italic font styles imply high intensity
128	displayed using the first available bold font in the font list. Bold	235	foreground/background (default). See resource B<intensityStyles> for
129	fonts should thus be specified in the font list after their	236	details.
130	corresponding regular fonts. If no bold font can be found, a regular
131	font will be used. resource B<realBold>.
132		237
133	=item B<-name> I<name>	238	=item B<-name> I<name>
134		239
135	Specify the application name under which resources are to be obtained,	240	Specify the application name under which resources are to be obtained,
136	rather than the default executable file name. Name should not contain	241	rather than the default executable file name. Name should not contain
…		…
174		279
175	Put scrollbar on right/left; resource B<scrollBar_right>.	280	Put scrollbar on right/left; resource B<scrollBar_right>.
176		281
177	=item B<-st>|B<+st>	282	=item B<-st>|B<+st>
178		283
179	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	284	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
180	resource B<scrollBar_floating>.	285	resource B<scrollBar_floating>.
		286
		287	=item B<-ptab>|B<+ptab>
		288
		289	If enabled (default), "Horizontal Tab" characters are being stored as
		290	actual wide characters in the screen buffer, which makes it possible to
		291	select and paste them. Since a horizontal tab is a cursor movement and
		292	not an actual glyph, this can sometimes be visually annoying as the cursor
		293	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
181		294
182	=item B<-bc>|B<+bc>	295	=item B<-bc>|B<+bc>
183		296
184	Blink the cursor; resource B<cursorBlink>.	297	Blink the cursor; resource B<cursorBlink>.
185		298
…		…
208		321
209	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	322	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	323	if honoured by the WM, the rxvt-unicode window will not have window
211	decorations; resource B<borderLess>.	324	decorations; resource B<borderLess>.
212		325
		326	=item B<-override-redirect>
		327
		328	Compile I<frills>: Sets override-redirect on the window; resource
		329	B<override-redirect>.
		330
		331	=item B<-sbg>
		332
		333	Compile I<frills>: Disable the usage of the built-in block graphics/line
		334	drawing characters and just rely on what the specified fonts provide. Use
		335	this if you have a good font and want to use its block graphic glyphs;
		336	resource B<skipBuiltinGlyphs>.
		337
213	=item B<-lsp> I<number>	338	=item B<-lsp> I<number>
214		339
215	Compile I<linespace>: Lines (pixel height) to insert between each row	340	Compile I<frills>: Lines (pixel height) to insert between each row of
216	of the display; resource B<linespace>.	341	the display. Useful to work around font rendering problems; resource
		342	B<linespace>.
217		343
218	=item B<-tn> I<termname>	344	=item B<-tn> I<termname>
219		345
220	This option specifies the name of the terminal type to be set in the	346	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	347	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	356	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	357	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,	358	run the program specified by the B<SHELL> environment variable or,
233	failing that, I<sh(1)>.	359	failing that, I<sh(1)>.
234		360
		361	Please note that you must specify a program with arguments. If you want to
		362	run shell commands, you have to specify the shell, like this:
		363
		364	@@RXVT_NAME@@ -e sh -c "shell commands"
		365
235	=item B<-title> I<text>	366	=item B<-title> I<text>
236		367
237	Window title (B<-T> still respected); the default title is the basename	368	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	369	of the program specified after the B<-e> option, if any, otherwise the
239	application name; resource B<title>.	370	application name; resource B<title>.
…		…
257		388
258	Compile I<XIM>: input method name. resource B<inputMethod>.	389	Compile I<XIM>: input method name. resource B<inputMethod>.
259		390
260	=item B<-imlocale> I<string>	391	=item B<-imlocale> I<string>
261		392
262	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	393	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	394	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	395	input extension to be able to input japanese characters while staying in
265	another locale.	396	another locale. resource B<imLocale>.
		397
		398	=item B<-imfont> I<fontset>
		399
		400	Set the font set to use for the X Input Method, see resource B<imFont>
		401	for more info.
		402
		403	=item B<-tcw>
		404
		405	Change the meaning of triple-click selection with the left mouse
		406	button. Only effective when the original (non-perl) selection code is
		407	in-use. Instead of selecting a full line it will extend the selection the
		408	end of the logical line only. resource B<tripleclickwords>.
266		409
267	=item B<-insecure>	410	=item B<-insecure>
268		411
269	Enable "insecure" mode, which currently enables most of the escape	412	Enable "insecure" mode, which currently enables most of the escape
270	sequences that echo strings. See the resource B<insecure> for more	413	sequences that echo strings. See the resource B<insecure> for more
…		…
284	=item B<-ssr>|B<+ssr>	427	=item B<-ssr>|B<+ssr>
285		428
286	Turn on/off secondary screen scroll (default enabled); resource	429	Turn on/off secondary screen scroll (default enabled); resource
287	B<secondaryScroll>.	430	B<secondaryScroll>.
288		431
		432	=item B<-hold>|B<+hold>
		433
		434	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		435	will not immediately destroy its window when the program executed within
		436	it exits. Instead, it will wait till it is being killed or closed by the
		437	user; resource B<hold>.
		438
		439	=item B<-keysym.>I<sym> I<string>
		440
		441	Remap a key symbol. See resource B<keysym>.
		442
		443	=item B<-embed> I<windowid>
		444
		445	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		446	which enables applications to easily embed a terminal.
		447
		448	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		449	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		450	quite a bit, so don't expect it to keep some specific state. It's best to
		451	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		452
		453	The window will not be destroyed when @@RXVT_NAME@@ exits.
		454
		455	It might be useful to know that @@RXVT_NAME@@ will not close file
		456	descriptors passed to it (except for stdin/out/err, of course), so you
		457	can use file descriptors to communicate with the programs within the
		458	terminal. This works regardless of whether the C<-embed> option was used or
		459	not.
		460
		461	Here is a short Gtk2-perl snippet that illustrates how this option can be
		462	used (a longer example is in F<doc/embed>):
		463
		464	my $rxvt = new Gtk2::Socket;
		465	$rxvt->signal_connect_after (realize => sub {
		466	my $xid = $_[0]->window->get_xid;
		467	system "@@RXVT_NAME@@ -embed $xid &";
		468	});
		469
		470	=item B<-pty-fd> I<file descriptor>
		471
		472	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		473	pair but instead use the given file descriptor as the tty master. This is
		474	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		475	without having to run a program within it.
		476
		477	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		478	entries and will not tinker with pty/tty permissions - you have to do that
		479	yourself if you want that.
		480
		481	As an extremely special case, specifying C<-1> will completely suppress
		482	pty/tty operations.
		483
		484	Here is a example in perl that illustrates how this option can be used (a
		485	longer example is in F<doc/pty-fd>):
		486
		487	use IO::Pty;
		488	use Fcntl;
		489
		490	my $pty = new IO::Pty;
		491	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		492	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		493	close $pty;
		494
		495	# now communicate with rxvt
		496	my $slave = $pty->slave;
		497	while (<$slave>) { print $slave "got <$_>\n" }
		498
289	=item B<-xrm> I<resourcestring>	499	=item B<-pe> I<string>
290		500
291	No effect on rxvt-unicode. Simply passes through an argument to be made	501	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	502	this terminal instance. See resource B<perl-ext> for details.
293	some window managers.
294		503
295	=back	504	=back
296		505
297	=head1 RESOURCES (available also as long-options)	506	=head1 RESOURCES (available also as long-options)
298		507
299	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	508	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
300	options) compiled into your version.	509	options) compiled into your version.
301		510
302	There are two different methods that @@RXVT_NAME@@ can use to get the	511	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	512	distribution do also load settings from the B<~/.Xresources> file when X
304	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	513	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	514	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		515
309	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	516	1. system-wide app-defaults file, either locale-dependent OR global
310	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	517	2. app-defaults file in $XAPPLRESDIR
311	set in XAPPLOADDIR/URxvt (compile-time defined: usually	518	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
312	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	519	4. SCREEN_RESOURCES for the current screen
313	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	520	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		521
314	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	522	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	523	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	524	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	525	configured, while the class name B<URxvt> allows resources unique to
318	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	526	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
319	shared between different B<@@RXVT_NAME@@> configurations. If no	527	configurations. If no resources are specified, suitable defaults will
320	resources are specified, suitable defaults will be used. Command-line	528	be used. Command-line arguments can be used to override resource
321	arguments can be used to override resource settings. The following	529	settings. The following resources are supported (you might want to
322	resources are allowed:	530	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		531	extensions not documented here):
323		532
324	=over 4	533	=over 4
		534
		535	=item B<depth:> I<bitdepth>
		536
		537	Compile I<xft>: Attempt to find a visual with the given bit depth;
		538	option B<-depth>.
325		539
326	=item B<geometry:> I<geom>	540	=item B<geometry:> I<geom>
327		541
328	Create the window with the specified X window geometry [default 80x24];	542	Create the window with the specified X window geometry [default 80x24];
329	option B<-geometry>.	543	option B<-geometry>.
…		…
345	high-intensity (bold = bright foreground, blink = bright background)	559	high-intensity (bold = bright foreground, blink = bright background)
346	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	560	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	561	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.	562	names used are listed in the B<COLORS AND GRAPHICS> section.
349		563
		564	Colours higher than 15 cannot be set using resources (yet), but can be
		565	changed using an escape command (see @@RXVT_NAME@@(7)).
		566
		567	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		568	88 colour support). Colours 80-87 are evenly spaces grey steps.
		569
350	=item B<colorBD:> I<colour>	570	=item B<colorBD:> I<colour>
351		571
		572	=item B<colorIT:> I<colour>
		573
352	Use the specified colour to display bold characters when the foreground	574	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	575	foreground colour is the default. If font styles are not available
354	enabled.	576	(Compile I<styles>) and this option is unset, reverse video is used instead.
355		577
356	=item B<colorUL:> I<colour>	578	=item B<colorUL:> I<colour>
357		579
358	Use the specified colour to display underlined characters when the	580	Use the specified colour to display underlined characters when the
359	foreground colour is the default.	581	foreground colour is the default.
360		582
361	=item B<colorRV:> I<colour>	583	=item B<colorRV:> I<colour>
362		584
363	Use the specified colour as the background for reverse video	585	Use the specified colour as the background for reverse video characters
364	characters.	586	when OPTION_HC is disabled (--disable-frills).
		587
		588	=item B<underlineColor:> I<colour>
		589
		590	If set, use the specified colour as the colour for the underline
		591	itself. If unset, use the foreground colour.
365		592
366	=item B<cursorColor:> I<colour>	593	=item B<cursorColor:> I<colour>
367		594
368	Use the specified colour for the cursor. The default is to use the	595	Use the specified colour for the cursor. The default is to use the
369	foreground colour; option B<-cr>.	596	foreground colour; option B<-cr>.
…		…
390		617
391	B<True>: make the background inherit the parent windows' pixmap, giving	618	B<True>: make the background inherit the parent windows' pixmap, giving
392	artificial transparency. B<False>: do not inherit the parent windows'	619	artificial transparency. B<False>: do not inherit the parent windows'
393	pixmap.	620	pixmap.
394		621
		622	I<Please note that transparency of any kind if completely unsupported by
		623	the author. Don't bug him with installation questions!>
		624
395	=item B<fading:> I<number>	625	=item B<fading:> I<number>
396		626
397	Fade the text by the given percentage when focus is lost.	627	Fade the text by the given percentage when focus is lost; option B<-fade>.
		628
		629	=item B<fadeColor:> I<colour>
		630
		631	Fade to this colour, when fading is used (see B<fading:>). The default
		632	colour is black; option B<-fadecolor>.
398		633
399	=item B<tintColor:> I<colour>	634	=item B<tintColor:> I<colour>
400		635
401	Tint the transparent background pixmap with the given colour.	636	Tint the transparent background pixmap with the given colour; option
		637	B<-tint>.
402		638
403	=item B<shading:> I<number>	639	=item B<shading:> I<number>
404		640
405	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	641	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
406	image in addition to tinting it.	642	in addition to tinting it; option B<-sh>.
407		643
		644	=item B<blendType:> I<string>
		645
		646	Specify background blending type; option B<-blt>.
		647
408	=item B<fading:> I<number>	648	=item B<blurRadius:> I<number>
409		649
410	Scale the tint colour by the given percentage.	650	Apply Gaussian Blurr with the specified radius to the transparent
		651	background image; option B<-blr>.
411		652
412	=item B<scrollColor:> I<colour>	653	=item B<scrollColor:> I<colour>
413		654
414	Use the specified colour for the scrollbar [default #B2B2B2].	655	Use the specified colour for the scrollbar [default #B2B2B2].
415		656
416	=item B<troughColor:> I<colour>	657	=item B<troughColor:> I<colour>
417		658
418	Use the specified colour for the scrollbar's trough area [default	659	Use the specified colour for the scrollbar's trough area [default
419	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	660	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
		661
		662	=item B<borderColor:> I<colour>
		663
		664	The colour of the border around the text area and between the scrollbar
		665	and the text.
420		666
421	=item B<backgroundPixmap:> I<file[;geom]>	667	=item B<backgroundPixmap:> I<file[;geom]>
422		668
423	Use the specified XPM file (note the `.xpm' extension is optional) for	669	Use the specified image file for the background and also optionally
424	the background and also optionally specify its scaling with a geometry	670	specify its scaling with a geometry string B<WxH+X+Y>,
425	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	671	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
426	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	672	and B<"X" / "Y"> locate the image centre (percent).
427	centre (percent). A scale of 0 displays the image with tiling. A scale	673	A scale of 0 displays the image with tiling. A scale of 1 displays the
428	of 1 displays the image without any scaling. A scale of 2 to 9	674	image without any scaling. A scale of 2 to 9 specifies an integer
429	specifies an integer number of images in that direction. No image will	675	number of images in that direction. No image will be magnified beyond
430	be magnified beyond 10 times its original size. The maximum permitted	676	10 times its original size. The maximum permitted scale is 1000.
431	scale is 1000. [default 0x0+50+50]	677	Special string of B<"auto"> used as a geometry will cause image to be
432		678	automatically scaled to match window size.
433	=item B<menu:> I<file[;tag]>	679	If used in conjunction with B<-tr> option - specified pixmap will be
434		680	blended over transparency image using either alpha-blending, or any
435	Read in the specified menu file (note the `.menu' extension is	681	other blending type, specified with B<-blt "type"> option.
436	optional) and also optionally specify a starting tag to find. See the	682	[default 0x0+50+50]
437	reference documentation for details on the syntax for the menuBar.
438		683
439	=item B<path:> I<path>	684	=item B<path:> I<path>
440		685
441	Specify the colon-delimited search path for finding files (XPM and	686	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		687
445	=item B<font:> I<fontname>	688	=item B<font:> I<fontlist>
446		689
447	Select the fonts to be used. This is a comma seperated list of font	690	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.	691	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	692	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	693	smaller, but not (in general) larger. A (hopefully) reasonable default
451	appended to it. option B<-fn>.	694	font list is always appended to it; option B<-fn>.
452		695
453	=item B<realBold:> I<boolean>	696	Each font can either be a standard X11 core font (XLFD) name, with
		697	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
454		698
455	B<True>: Enable "real bold" support. When this option is on, bold text	699	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.	700	specifications enclosed in square brackets (C<[]>). The only available
457	Bold fonts should thus be specified in the font list after their	701	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	702	fonts.
459	font will be used. option B<-rb>. B<False>: Display bold text in a	703
460	regular font, using the color specified with B<colorBD>; option B<+rb>.	704	For example, this font resource
		705
		706	URxvt.font: 9x15bold,\
		707	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		708	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		709	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		710	xft:Code2000:antialias=false
		711
		712	specifies five fonts to be used. The first one is C<9x15bold> (actually
		713	the iso8859-1 version of the second font), which is the base font (because
		714	it is named first) and thus defines the character cell grid to be 9 pixels
		715	wide and 15 pixels high.
		716
		717	The second font is just used to add additional unicode characters not in
		718	the base font, likewise the third, which is unfortunately non-bold, but
		719	the bold version of the font does contain less characters, so this is a
		720	useful supplement.
		721
		722	The third font is an Xft font with aliasing turned off, and the characters
		723	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		724	contains other characters, but we are not interested in them.
		725
		726	The last font is a useful catch-all font that supplies most of the
		727	remaining unicode characters.
		728
		729	=item B<boldFont:> I<fontlist>
		730
		731	=item B<italicFont:> I<fontlist>
		732
		733	=item B<boldItalicFont:> I<fontlist>
		734
		735	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		736	italic> >> characters, respectively.
		737
		738	If specified and non-empty, then the syntax is the same as for the
		739	B<font>-resource, and the given font list will be used as is, which makes
		740	it possible to substitute completely different font styles for bold and
		741	italic.
		742
		743	If unset (the default), a suitable font list will be synthesized by
		744	"morphing" the normal text font list into the desired shape. If that is
		745	not possible, replacement fonts of the desired shape will be tried.
		746
		747	If set, but empty, then this specific style is disabled and the normal
		748	text font will being used for the given style.
		749
		750	=item B<intensityStyles:> I<boolean>
		751
		752	When font styles are not enabled, or this option is enabled (B<True>,
		753	option B<-is>, the default), bold and italic font styles imply high
		754	intensity foreground/background colours. Disabling this option (B<False>,
		755	option B<+is>) disables this behaviour, the high intensity colours are not
		756	reachable.
461		757
462	=item B<selectstyle:> I<mode>	758	=item B<selectstyle:> I<mode>
463		759
464	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	760	Set mouse selection style to B<old> which is 2.20, B<oldword> which
465	xterm style with 2.20 old word selection, or anything else which gives	761	is xterm style with 2.20 old word selection, or anything else which
466	xterm style selection.	762	gives xterm style selection. Only effective when the original (non-perl)
		763	selection code is in use.
467		764
468	=item B<scrollstyle:> I<mode>	765	=item B<scrollstyle:> I<mode>
469		766
470	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	767	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
471	the author's favourite..	768	the author's favourite.
472		769
473	=item B<title:> I<string>	770	=item B<title:> I<string>
474		771
475	Set window title string, the default title is the command-line	772	Set window title string, the default title is the command-line
476	specified after the B<-e> option, if any, otherwise the application	773	specified after the B<-e> option, if any, otherwise the application
…		…
485	=item B<mapAlert:> I<boolean>	782	=item B<mapAlert:> I<boolean>
486		783
487	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	784	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
488	de-iconify (map) on receipt of a bell character [default].	785	de-iconify (map) on receipt of a bell character [default].
489		786
		787	=item B<urgentOnBell:> I<boolean>
		788
		789	B<True>: set the urgency hint for the wm on receipt of a bell character.
		790	B<False>: do not set the urgency hint [default].
		791
490	=item B<visualBell:> I<boolean>	792	=item B<visualBell:> I<boolean>
491		793
492	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	794	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
493	B<False>: no visual bell [default]; option B<+vb>.	795	B<False>: no visual bell [default]; option B<+vb>.
494		796
…		…
508		810
509	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	811	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	812	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.	813	B<Shift-Print> to include the scrollback as well.
512		814
		815	The string will be interpreted as if typed into the shell as-is.
		816
		817	Example:
		818
		819	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		820
		821	This creates a new file in your home directory with the screen contents
		822	every time you hit C<Print>.
		823
513	=item B<scrollBar:> I<boolean>	824	=item B<scrollBar:> I<boolean>
514		825
515	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	826	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
516	disable the scrollbar; option B<+sb>.	827	disable the scrollbar; option B<+sb>.
517		828
…		…
530	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar	841	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
531	thumb with the pointer on middle button press/drag.	842	thumb with the pointer on middle button press/drag.
532		843
533	=item B<scrollTtyOutput:> I<boolean>	844	=item B<scrollTtyOutput:> I<boolean>
534		845
535	B<True>: scroll to bottom when tty receives output; option B<+si>.	846	B<True>: scroll to bottom when tty receives output; option B<-si>.
536	B<False>: do not scroll to bottom when tty receives output; option	847	B<False>: do not scroll to bottom when tty receives output; option
537	B<-si>.	848	B<+si>.
538		849
539	=item B<scrollWithBuffer:> I<boolean>	850	=item B<scrollWithBuffer:> I<boolean>
540		851
541	B<True>: scroll with scrollback buffer when tty recieves new lines (and	852	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	853	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
543	with scrollback buffer when tty recieves new lines; option B<-sw>.	854	with scrollback buffer when tty receives new lines; option B<+sw>.
544		855
545	=item B<scrollTtyKeypress:> I<boolean>	856	=item B<scrollTtyKeypress:> I<boolean>
546		857
547	B<True>: scroll to bottom when a non-special key is pressed. Special keys	858	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	859	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	860	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>.	861	bottom when a non-special key is pressed; option B<+sk>.
551		862
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>	863	=item B<saveLines:> I<number>
563		864
564	Save I<number> lines in the scrollback buffer [default 64]. This	865	Save I<number> lines in the scrollback buffer [default 64]. This
565	resource is limited on most machines to 65535; option B<-sl>.	866	resource is limited on most machines to 65535; option B<-sl>.
566		867
…		…
577	=item B<borderLess:> I<boolean>	878	=item B<borderLess:> I<boolean>
578		879
579	Set MWM hints to request a borderless window, i.e. if honoured by the	880	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>.	881	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
581		882
		883	=item B<skipBuiltinGlyphs:> I<boolean>
		884
		885	Compile I<frills>: Disable the usage of the built-in block graphics/line
		886	drawing characters and just rely on what the specified fonts provide. Use
		887	this if you have a good font and want to use its block graphic glyphs;
		888	option B<-sbg>.
		889
582	=item B<termName:> I<termname>	890	=item B<termName:> I<termname>
583		891
584	Specifies the terminal type name to be set in the B<TERM> environment	892	Specifies the terminal type name to be set in the B<TERM> environment
585	variable; option B<-tn>.	893	variable; option B<-tn>.
586		894
…		…
596		904
597	=item B<mouseWheelScrollPage:> I<boolean>	905	=item B<mouseWheelScrollPage:> I<boolean>
598		906
599	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	907	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
600	scrolls five lines [default].	908	scrolls five lines [default].
		909
		910	=item B<pastableTabs:> I<boolean>
		911
		912	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		913	movement only; option C<-ptab>.
601		914
602	=item B<cursorBlink:> I<boolean>	915	=item B<cursorBlink:> I<boolean>
603		916
604	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	917	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
605	option B<-bc>.	918	option B<-bc>.
…		…
618		931
619	Mouse pointer background colour.	932	Mouse pointer background colour.
620		933
621	=item B<pointerBlankDelay:> I<number>	934	=item B<pointerBlankDelay:> I<number>
622		935
623	Specifies number of seconds before blanking the pointer [default 2].	936	Specifies number of seconds before blanking the pointer [default 2]. Use a
		937	large number (e.g. C<987654321>) to effectively disable the timeout.
624		938
625	=item B<backspacekey:> I<string>	939	=item B<backspacekey:> I<string>
626		940
627	The string to send when the backspace key is pressed. If set to B<DEC>	941	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>	942	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	949	pressed. If unset it will send the sequence traditionally associated
636	with the B<Execute> key.	950	with the B<Execute> key.
637		951
638	=item B<cutchars:> I<string>	952	=item B<cutchars:> I<string>
639		953
640	The characters used as delimiters for double-click word selection. The	954	The characters used as delimiters for double-click word selection
641	built-in default:	955	(whitespace delimiting is added automatically if resource is given).
		956
		957	When the perl selection extension is in use (the default if compiled
		958	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		959	characters will be created (if the resource exists, otherwise, no regex
		960	will be created). In this mode, characters outside ISO-8859-1 can be used.
		961
		962	When the selection extension is not used, only ISO-8859-1 characters can
		963	be used. If not specified, the built-in default is used:
642		964
643	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	965	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
644		966
645	=item B<preeditType:> I<style>	967	=item B<preeditType:> I<style>
646		968
…		…
650		972
651	I<name> of inputMethod to use; option B<-im>.	973	I<name> of inputMethod to use; option B<-im>.
652		974
653	=item B<imLocale:> I<name>	975	=item B<imLocale:> I<name>
654		976
655	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	977	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	978	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	979	input extension to be able to input japanese characters while staying in
658	another locale. option B<-imlocale>.	980	another locale; option B<-imlocale>.
659		981
660	=item B<insecure>	982	=item B<imFont:> I<fontset>
		983
		984	Specify the font-set used for XIM styles C<OverTheSpot> or
		985	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		986	by commas), i.e. it's not in the same format as the other font lists used
		987	in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
		988	found, preferably one or two pixels differing in size to the base font.
		989	option B<-imfont>.
		990
		991	=item B<tripleclickwords:> I<boolean>
		992
		993	Change the meaning of triple-click selection with the left mouse
		994	button. Instead of selecting a full line it will extend the selection to
		995	the end of the logical line only; option B<-tcw>.
		996
		997	=item B<insecure:> I<boolean>
661		998
662	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	999	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
663	echo arbitrary strings like the icon name or the locale. This could be	1000	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	1001	abused if somebody gets 8-bit-clean access to your display, whether
665	throuh a mail client displaying mail bodies unfiltered or though	1002	through a mail client displaying mail bodies unfiltered or through
666	write(1). Therefore, these sequences are disabled by default. (Note	1003	write(1) or any other means. Therefore, these sequences are disabled by
667	that other terminals, including xterm, have these sequences	1004	default. (Note that many other terminals, including xterm, have these
668	enabled by default). You can enable them by setting this boolean	1005	sequences enabled by default, which doesn't make it safer, though).
669	resource or specifying B<-insecure> as an option. At the moment, this	1006
670	enabled display-answer, locale, findfont, icon label and window title	1007	You can enable them by setting this boolean resource or specifying
671	requests as well as dynamic menubar dispatch.	1008	B<-insecure> as an option. At the moment, this enables display-answer,
		1009	locale, findfont, icon label and window title requests.
672		1010
673	=item B<modifier:> I<modifier>	1011	=item B<modifier:> I<modifier>
674		1012
675	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1013	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	1014	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
680		1018
681	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1019	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	1020	character is passed through. It may contain escape values as described
683	in the entry on B<keysym> following.	1021	in the entry on B<keysym> following.
684		1022
685	=item B<secondaryScreen:> I<bool>	1023	=item B<secondaryScreen:> I<boolean>
686		1024
687	Turn on/off secondary screen (default enabled).	1025	Turn on/off secondary screen (default enabled).
688		1026
689	=item B<secondaryScroll:> I<bool>	1027	=item B<secondaryScroll:> I<boolean>
690		1028
691	Turn on/off secondary screen scroll (default enabled). If the this	1029	Turn on/off secondary screen scroll (default enabled). If this
692	option is enabled, scrolls on the secondary screen will change the	1030	option is enabled, scrolls on the secondary screen will change the
693	scrollback buffer and switching to/from the secondary screen will	1031	scrollback buffer and switching to/from the secondary screen will
694	instead scroll the screen up.	1032	instead scroll the screen up.
695		1033
		1034	=item B<hold>: I<boolean>
		1035
		1036	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1037	will not immediately destroy its window when the program executed within
		1038	it exits. Instead, it will wait till it is being killed or closed by the
		1039	user.
		1040
696	=item B<keysym.>I<sym>: I<string>	1041	=item B<keysym.>I<sym>: I<string>
697		1042
698	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1043	Compile I<frills>: Associate I<string> with keysym I<sym>. The
699	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	1044	intervening resource name B<keysym.> cannot be omitted.
700	newline, \r: return, \t:	1045
		1046	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		1047	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		1048	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1049	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1050	B<2>, B<3>, B<4>, B<5>.
		1051
		1052	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1053	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1054	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1055	current application keymap mode state.
		1056
		1057	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1058	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1059	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1060	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1061	performed in an exact manner; however, the closest match is assured.
		1062
		1063	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
		1064	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,	1065	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	1066	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	1067	can start or end with whitespace. B<This feature is deprecated and will
704	omitted. This resource is only available when compiled with	1068	be removed>.
705	KEYSYM_RESOURCE.	1069
		1070	Please note that you need to double the C<\> in resource files, as
		1071	Xlib itself does its own de-escaping (you can use C<\033> instead of
		1072	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
		1073	processing).
		1074
		1075	You can define a range of keysyms in one shot by providing a I<string>
		1076	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
		1077	should be a character not used by the strings.
		1078
		1079	Its usage can be demonstrated by an example:
		1080
		1081	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
		1082
		1083	The above line is equivalent to the following three lines:
		1084
		1085	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1086	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1087	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1088
		1089	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1090	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1091	example the following means "change the current locale to C<zh_CN.GBK>
		1092	when Control-Meta-c is being pressed":
		1093
		1094	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1095
		1096	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1097	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1098	manpage. For example, the F<selection> extension (activated via
		1099	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1100
		1101	URxvt.keysym.M-C-c: perl:selection:rot13
		1102
		1103	Due the the large number of modifier combinations, a defined key mapping
		1104	will match if at I<at least> the specified identifiers are being set, and
		1105	no other key mappings with those and more bits are being defined. That
		1106	means that defining a key map for C<a> will automatically provide
		1107	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1108	mappings themselves.
		1109
		1110	Unfortunately, this will override built-in key mappings. For example
		1111	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1112	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1113	user-defined keymap using the C<builtin:> replacement:
		1114
		1115	URxvt.keysym.Insert: <my insert key sequence>
		1116	URxvt.keysym.S-Insert: builtin:
		1117
		1118	The first line defines a mapping for C<Insert> and I<any> combination
		1119	of modifiers. The second line re-establishes the default mapping for
		1120	C<Shift-Insert>.
		1121
		1122	The following example will map Control-Meta-1 and Control-Meta-2 to
		1123	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1124	font-switching at runtime:
		1125
		1126	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1127	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1128
		1129	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1130	info):
		1131
		1132	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1133	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1134
		1135	=item B<perl-ext-common>: I<string>
		1136
		1137	=item B<perl-ext>: I<string>
		1138
		1139	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1140	use in this terminal instance; option B<-pe>.
		1141
		1142	Extension names can be prefixed with a C<-> sign to prohibit using
		1143	them. This can be useful to selectively disable some extensions loaded
		1144	by default, or specified via the C<perl-ext-common> resource. For
		1145	example, C<default,-selection> will use all the default extension except
		1146	C<selection>.
		1147
		1148	Extension names can also be followed by an argument in angle brackets
		1149	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1150	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1151	multiple times with different arguments will pass multiple arguments to
		1152	the extension.
		1153
		1154	Each extension is looked up in the library directories, loaded if
		1155	necessary, and bound to the current terminal instance.
		1156
		1157	If both of these resources are the empty string, then the perl
		1158	interpreter will not be initialized. The idea behind two options is that
		1159	B<perl-ext-common> will be used for extensions that should be available to
		1160	all instances, while B<perl-ext> is used for specific instances.
		1161
		1162	=item B<perl-eval>: I<string>
		1163
		1164	Perl code to be evaluated when all extensions have been registered. See
		1165	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1166	will be ignored when running setuid/setgid.
		1167
		1168	=item B<perl-lib>: I<path>
		1169
		1170	Colon-separated list of additional directories that hold extension
		1171	scripts. When looking for extensions specified by the C<perl> resource,
		1172	@@RXVT_NAME@@ will first look in these directories and then in
		1173	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1174	will be ignored when running setuid/setgid.
		1175
		1176	See the @@RXVT_NAME@@perl(3) manpage.
		1177
		1178	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1179
		1180	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1181	details.
		1182
		1183	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1184
		1185	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1186	for details.
		1187
		1188	=item B<searchable-scrollback:> I<keysym>
		1189
		1190	Sets the hotkey that starts the incremental scrollback buffer search
		1191	(default: C<M-s>).
		1192
		1193	=item B<urlLauncher>: I<string>
		1194
		1195	Specifies the program to be started with a URL argument. Used by the
		1196	C<selection-popup> and C<matcher> perl extensions.
		1197
		1198	=item B<transient-for>: I<windowid>
		1199
		1200	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1201
		1202	=item B<override-redirect>: I<boolean>
		1203
		1204	Compile I<frills>: Sets override-redirect for the terminal window, making
		1205	it almost invisible to window managers; option B<-override-redirect>.
706		1206
707	=back	1207	=back
708		1208
709	=head1 THE SCROLLBAR	1209	=head1 THE SCROLLBAR
710		1210
…		…
724	the normal text selection/insertion, hold either the Shift or the Meta	1224	the normal text selection/insertion, hold either the Shift or the Meta
725	(Alt) key while performing the desired mouse action.	1225	(Alt) key while performing the desired mouse action.
726		1226
727	If mouse reporting mode is active, the normal scrollbar actions are	1227	If mouse reporting mode is active, the normal scrollbar actions are
728	disabled -- on the assumption that we are using a fullscreen	1228	disabled -- on the assumption that we are using a fullscreen
729	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1229	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
730	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1230	(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),	1231	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
732	respectively.	1232	respectively.
733		1233
734	=head1 TEXT SELECTION AND INSERTION	1234	=head1 THE SELECTION: SELECTING AND PASTING TEXT
735		1235
736	The behaviour of text selection and insertion mechanism is similar to	1236	The behaviour of text selection and insertion/pasting mechanism is similar
737	I<xterm>(1).	1237	to I<xterm>(1).
738		1238
739	=over 4	1239	=over 4
740		1240
741	=item B<Selection>:	1241	=item B<Selecting>:
742		1242
743	Left click at the beginning of the region, drag to the end of the	1243	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	1244	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	1245	to select a word; Left triple-click to select the entire logical line
746	line.	1246	(which can span multiple screen lines), unless modified by resource
		1247	B<tripleclickwords>.
747		1248
		1249	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1250	(Compile: I<frills>) will create a rectangular selection instead of a
		1251	normal one. In this mode, every selected row becomes its own line in the
		1252	selection, and trailing whitespace is visually underlined and removed from
		1253	the selection.
		1254
748	=item B<Insertion>:	1255	=item B<Pasting>:
749		1256
750	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1257	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	1258	window causes the value of the PRIMARY selection (or CLIPBOARD with the
752	inserted as if it had been typed on the keyboard.	1259	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1260
		1261	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1262	inserted too.
753		1263
754	=back	1264	=back
755		1265
756	=head1 CHANGING FONTS	1266	=head1 CHANGING FONTS
757		1267
758	You can change fonts on-the-fly, which is to say cycle through the	1268	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	1269	supported in rxvt-unicode. Bug me if you need this.
760	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1270
761	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1271	You can, however, switch fonts at runtime using escape sequences, e.g.:
762	actual key can be selected using resources	1272
763	B<smallfont_key>/B<bigfont_key>.	1273	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1274
		1275	You can use keyboard shortcuts, too:
		1276
		1277	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1278	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
		1279
		1280	rxvt-unicode will automatically re-apply these fonts to the output so far.
764		1281
765	=head1 ISO 14755 SUPPORT	1282	=head1 ISO 14755 SUPPORT
766		1283
767	Partial ISO 14755-support is implemented. that means that pressing	1284	ISO 14755 is a standard for entering and viewing unicode characters
		1285	and character codes using the keyboard. It consists of 4 parts. The
		1286	first part is available rxvt-unicode has been compiled with
		1287	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1288	with C<--enable-iso14755>.
768		1289
769	Section 5.1: Control and Shift together enters unicode input	1290	=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		1291
774	Section 5.2: Pressing and immediately releasing Control and Shift together	1292	=item * 5.1: Basic method
775	enters keycap entry mode for the next key: pressing a function key (tab,	1293
776	return etc..) will enter the unicode character corresponding to the given	1294	This allows you to enter unicode characters using their hexcode.
777	key.	1295
		1296	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1297	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1298	commit the character as if it were typed directly. While holding down
		1299	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1300	C<Space>, which will commit the current character and lets you start a new
		1301	one.
		1302
		1303	As an example of use, imagine a business card with a japanese e-mail
		1304	address, which you cannot type. Fortunately, the card has the e-mail
		1305	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1306	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1307	followed by releasing the modifier keys.
		1308
		1309	=item * 5.2: Keyboard symbols entry method
		1310
		1311	This mode lets you input characters representing the keycap symbols of
		1312	your keyboard, if representable in the current locale encoding.
		1313
		1314	Start by pressing C<Control> and C<Shift> together, then releasing
		1315	them. The next special key (cursor keys, home etc.) you enter will not
		1316	invoke its usual function but instead will insert the corresponding
		1317	keycap symbol. The symbol will only be entered when the key has been
		1318	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1319	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1320	reverse tab (Shift-Tab).
		1321
		1322	=item * 5.3: Screen-selection entry method
		1323
		1324	While this is implemented already (it's basically the selection
		1325	mechanism), it could be extended by displaying a unicode character map.
		1326
		1327	=item * 5.4: Feedback method for identifying displayed characters for later input
		1328
		1329	This method lets you display the unicode character code associated with
		1330	characters already displayed.
		1331
		1332	You enter this mode by holding down C<Control> and C<Shift> together, then
		1333	pressing and holding the left mouse button and moving around. The unicode
		1334	hex code(s) (it might be a combining character) of the character under the
		1335	pointer is displayed until you release C<Control> and C<Shift>.
		1336
		1337	In addition to the hex codes it will display the font used to draw this
		1338	character - due to implementation reasons, characters combined with
		1339	combining characters, line drawing characters and unknown characters will
		1340	always be drawn using the built-in support font.
		1341
		1342	=back
		1343
		1344	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1345	both scenario A and B of ISO 14755, including part 5.2.
778		1346
779	=head1 LOGIN STAMP	1347	=head1 LOGIN STAMP
780		1348
781	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1349	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.	1350	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	1351	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
784	some systems.	1352	on some systems or setgid to root or to some other group on others.
785		1353
786	=head1 COLORS AND GRAPHICS	1354	=head1 COLORS AND GRAPHICS
787		1355
788	In addition to the default foreground and background colours,	1356	In addition to the default foreground and background colours,
789	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1357	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	1358	high-intensity bold/blink versions of the same). Here is a list of the
791	colours with their B<rgb.txt> names.	1359	colours with their names.
792		1360
793	=begin table	1361	=begin table
794		1362
795	B<color0> (black) = Black	1363	B<color0> (black) = Black
796	B<color1> (red) = Red3	1364	B<color1> (red) = Red3
…		…
816	It is also possible to specify the colour values of B<foreground>,	1384	It is also possible to specify the colour values of B<foreground>,
817	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1385	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	1386	a number 0-15, as a convenient shorthand to reference the colour name of
819	color0-color15.	1387	color0-color15.
820		1388
		1389	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1390	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1391	consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1392	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1393
		1394	Together, all those colours implement the 88 colour xterm colours. Only
		1395	the first 16 can be changed using resources currently, the rest can only
		1396	be changed via command sequences ("escape codes").
		1397
821	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1398	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
822	always swapping the foreground/background colours. This is in contrast to	1399	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	1400	I<xterm>(1) where the colours are only swapped if they have not otherwise
824	been specified. For example,	1401	been specified. For example,
825		1402
…		…
830	would yield White on Black, while on I<xterm>(1) it would yield Black	1407	would yield White on Black, while on I<xterm>(1) it would yield Black
831	on White.	1408	on White.
832		1409
833	=back	1410	=back
834		1411
		1412	=head2 ALPHA CHANNEL SUPPORT
		1413
		1414	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1415	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1416	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1417	in addition to the ones provided by X, where the additional A component
		1418	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1419	transparent). You can also prefix any color with C<[percent]>, where
		1420	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1421	the color, where C<0> is completely transparent and C<100> is completelxy
		1422	opaque.
		1423
		1424	You probably need to specify B<"-depth 32">, too, and have the luck that
		1425	your X-server uses ARGB pixel layout, as X is far from just supporting
		1426	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1427
		1428	For example, the following selects an almost completely transparent red
		1429	background, and an almost opaque pink foreground:
		1430
		1431	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1432
		1433	I<Please note that transparency of any kind if completely unsupported by
		1434	the author. Don't bug him with installation questions!>
		1435
835	=head1 ENVIRONMENT	1436	=head1 ENVIRONMENT
836		1437
837	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1438	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	1439
839	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1440	=over 4
840	sets the environment variable B<DISPLAY> to specify which display	1441
841	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1442	=item B<TERM>
842	B<RXVTPATH> and B<PATH> to find XPM files.	1443
		1444	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1445	resources or on the command line.
		1446
		1447	=item B<COLORTERM>
		1448
		1449	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1450	compiled with XPM support, and optionally with the added extension
		1451	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
		1452
		1453	=item B<COLORFGBG>
		1454
		1455	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1456	the colour code used as default foreground/text colour (or the string
		1457	C<default> to indicate that the default-colour escape sequence is to be
		1458	used), C<bg> is the colour code used as default background colour (or the
		1459	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1460	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
		1461	(and do) use this information to optimize screen output.
		1462
		1463	=item B<WINDOWID>
		1464
		1465	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1466	window, which usually has subwindows for the scrollbar, the terminal
		1467	window and so on).
		1468
		1469	=item B<TERMINFO>
		1470
		1471	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1472	C<--with-terminfo=PATH>.
		1473
		1474	=item B<DISPLAY>
		1475
		1476	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1477	display in its child processes.
		1478
		1479	=item B<SHELL>
		1480
		1481	The shell to be used for command execution, defaults to C</bin/sh>.
		1482
		1483	=item B<RXVT_SOCKET>
		1484
		1485	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1486	@@RXVT_NAME@@d(1).
		1487
		1488	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1489
		1490	=item B<HOME>
		1491
		1492	Used to locate the default directory for the unix domain socket for
		1493	daemon communications and to locate various resource files (such as
		1494	C<.Xdefaults>)
		1495
		1496	=item B<XAPPLRESDIR>
		1497
		1498	Directory where various X resource files are being located.
		1499
		1500	=item B<XENVIRONMENT>
		1501
		1502	If set and accessible, gives the name of a X resource file to be loaded by
		1503	@@RXVT_NAME@@.
		1504
		1505	=back
843		1506
844	=head1 FILES	1507	=head1 FILES
845		1508
846	=over 4	1509	=over 4
847		1510
848	=item B</etc/utmp>
849
850	System file for login records.
851
852	=item B</usr/lib/X11/rgb.txt>	1511	=item B</usr/lib/X11/rgb.txt>
853		1512
854	Color names.	1513	Color names.
855		1514
856	=back	1515	=back
857		1516
858	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1517	=head1 SEE ALSO
		1518
		1519	@@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)
		1520
		1521	=head1 CURRENT PROJECT COORDINATOR
859		1522
860	=over 4	1523	=over 4
861		1524
862	=item How do I know which rxvt-unicode version I'm using?	1525	=item Project Coordinator
863		1526
864	The version number is displayed with the usage (-h). For rxvt-unicode	1527	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		1528
868	=item Mouse cut/paste suddenly no longer works.	1529	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
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		1530
1077	=back	1531	=back
1078		1532
1079	=head1 SEE ALSO	1533	=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		1534
1093	=over 4	1535	=over 4
1094		1536
1095	=item Project Coordinator	1537	=item John Bovey
1096		1538
1097	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1539	University of Kent, 1992, wrote the original Xvt.
1098		1540
1099	=item Web page maintainter	1541	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>
1100		1542
1101	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>	1543	very heavily modified Xvt and came up with Rxvt
1102		1544
1103	L<@@RXVT_WEBPAGE@@>	1545	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>
		1546
		1547	wrote the Greek Keyboard Input (no longer in code)
		1548
		1549	=item mj olesen L<< <olesen@me.QueensU.CA> >>
		1550
		1551	Wrote the menu system.
		1552
		1553	Project Coordinator (changes.txt 2.11 to 2.21)
		1554
		1555	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>
		1556
		1557	Project Coordinator (changes.txt 2.21a to 2.4.5)
		1558
		1559	=item Geoff Wing L<< <gcw@pobox.com> >>
		1560
		1561	Rewrote screen display and text selection routines.
		1562
		1563	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
		1564
		1565	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
		1566
		1567	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
		1568	extension, random hacks, numerous bugfixes and extensions.
		1569
		1570	Project Coordinator (Changes 1.0 -)
		1571
		1572	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1573
		1574	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1104		1575
1105	=back	1576	=back
1106		1577
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