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.192 by sf-exg, Sat Dec 18 12:20:18 2010 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	This document is also available on the World-Wide-Web at
18	sequences etc.) and the FAQ section at the end of this document.	18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
		20	=head1 FREQUENTLY ASKED QUESTIONS
		21
		22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
		23	frequently asked questions and answer to them and some common
		24	problems. That document is also accessible on the World-Wide-Web at
		25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
		26
		27	=head1 RXVT-UNICODE VS. RXVT
		28
		29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
		30	internally. That means it can store and display most scripts in the
		31	world. Being a terminal emulator, however, some things are very difficult,
		32	especially cursive scripts such as arabic, vertically written scripts
		33	like mongolian or scripts requiring extremely complex combining rules,
		34	like tibetan or devanagari. Don't expect pretty output when using these
		35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
		36	fine, though. A somewhat difficult case are right-to-left scripts, such
		37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
		38	belong in the application, not the terminal emulator (too many things --
		39	such as cursor-movement while editing -- break otherwise), but that might
		40	change.
		41
		42	If you are looking for a terminal that supports more exotic scripts, let
		43	me recommend C<mlterm>, which is a very user friendly, lean and clean
		44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
		45	because the author couldn't get C<mlterm> to use one font for latin1 and
		46	another for japanese.
		47
		48	Therefore another design rationale was the use of multiple fonts to
		49	display characters: The idea of a single unicode font which many other
		50	programs force onto its users never made sense to me: You should be able
		51	to choose any font for any script freely.
		52
		53	Apart from that, rxvt-unicode is also much better internationalised than
		54	its predecessor, supports things such as XFT and ISO 14755 that are handy
		55	in i18n-environments, is faster, and has a lot bugs less than the original
		56	rxvt. This all in addition to dozens of other small improvements.
		57
		58	It is still faithfully following the original rxvt idea of being lean
		59	and nice on resources: for example, you can still configure rxvt-unicode
		60	without most of its features to get a lean binary. It also comes with
		61	a client/daemon pair that lets you open any number of terminal windows
		62	from within a single process, which makes startup time very fast and
		63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
		64	@@RXVT_NAME@@c(1) (client).
		65
		66	It also makes technical information about escape sequences (which have
		67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
		68	reference documentation (escape sequences etc.).
19		69
20	=head1 OPTIONS	70	=head1 OPTIONS
21		71
22	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	72	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	73	below. In keeping with the smaller-is-better philosophy, options may be
…		…
42		92
43	Print out a message describing available options.	93	Print out a message describing available options.
44		94
45	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
46		96
47	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
48	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
49	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
		100
		101	=item B<-depth> I<bitdepth>
		102
		103	Compile I<xft>: Attempt to find a visual with the given bit depth;
		104	resource B<depth>.
		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
50		110
51	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
52		112
53	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
54		114
…		…
56		116
57	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
58		118
59	=item B<-j>|B<+j>	119	=item B<-j>|B<+j>
60		120
61	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
62		122
63	=item B<-ip>|B<+ip>	123	=item B<-ss>|B<+ss>
64		124
65	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
66	B<-tr>; resource B<inheritPixmap>.	126
		127	=item B<-tr>|B<+tr>
		128
		129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
67		133
68	=item B<-fade> I<number>	134	=item B<-fade> I<number>
69		135
70	Fade the text by the given percentage when focus is lost.	136	Fade the text by the given percentage when focus is lost. Small values
		137	fade a little only, 100 completely replaces all colours by the fade
		138	colour; resource B<fading>.
		139
		140	=item B<-fadecolor> I<colour>
		141
		142	Fade to this colour when fading is used (see B<-fade>). The default colour
		143	is opaque black. resource B<fadeColor>.
71		144
72	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
73		146
74	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
75	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	148	resource I<tintColor>.
76	option that can be used to brighten or darken the image in addition to
77	tinting it.
78		149
79	=item B<-sh>	150	=item B<-sh> I<number>
80		151
81	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
82	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
83	specified, too).	154
		155	=item B<-blt> I<string>
		156
		157	Specify background blending type. If background pixmap is specified
		158	at the same time as transparency - such pixmap will be blended over
		159	the transparent background, using the method specified. Supported values are:
		160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
		161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		164
		165	=item B<-blr> I<HxV>
		166
		167	Apply Gaussian Blur with the specified radii to the transparent
		168	background. If a single number is specified - both vertical and
		169	horizontal radii are considered to be the same. Setting one of the
		170	radii to 1 and another to a large number creates interesting effects
		171	on some backgrounds. Maximum radius value is 128;
		172	resource I<blurRadius>.
		173
		174	=item B<-icon> I<file>
		175
		176	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		177	is used by many window managers, taskbars and pagers to represent the
		178	application window; resource I<iconFile>.
84		179
85	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
86		181
87	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
88		183
89	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
90		185
91	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
92		187
93	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
94		189
95	Compile I<XPM>: Specify XPM file for the background and also optionally	190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
96	specify its scaling with a geometry string. Note you may need to add	191	optionally specify its scaling with a geometry string. Note you may need to
97	quotes to avoid special shell interpretation of the `;' in the	192	add quotes to avoid special shell interpretation of the C<;> in the
98	command-line; resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
99		194
100	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
101		196
102	The cursor colour; resource B<cursorColor>.	197	The cursor colour; resource B<cursorColor>.
103		198
…		…
109		204
110	The mouse pointer background colour; resource B<pointerColor2>.	205	The mouse pointer background colour; resource B<pointerColor2>.
111		206
112	=item B<-bd> I<colour>	207	=item B<-bd> I<colour>
113		208
114	The colour of the border between the xterm scrollbar and the text;	209	The colour of the border around the text area and between the scrollbar and the text;
115	resource B<borderColor>.	210	resource B<borderColor>.
116		211
117	=item B<-fn> I<fontname>	212	=item B<-fn> I<fontlist>
118		213
119	Select the fonts to be used. This is a comma seperated list of font	214	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.	215	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	216	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	217	smaller, but not (in general) larger. A (hopefully) reasonable default
123	appended to it. resource B<font>.	218	font list is always appended to it. See resource B<font> for more details.
124		219
		220	In short, to specify an X11 core font, just specify its name or prefix it
		221	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		222	e.g.:
		223
		224	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		225	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
		226
		227	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
		228	section of @@RXVT_NAME@@(7).
		229
		230	=item B<-fb> I<fontlist>
		231
		232	Compile I<font-styles>: The bold font list to use when B<bold> characters
		233	are to be printed. See resource B<boldFont> for details.
		234
		235	=item B<-fi> I<fontlist>
		236
		237	Compile I<font-styles>: The italic font list to use when I<italic>
		238	characters are to be printed. See resource B<italicFont> for details.
		239
		240	=item B<-fbi> I<fontlist>
		241
		242	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
		243	italic> >> characters are to be printed. See resource B<boldItalicFont>
		244	for details.
		245
125	=item B<-rb>|B<+rb>	246	=item B<-is>|B<+is>
126		247
127	Enable "real bold" support. When this option is on, bold text will be	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
128	displayed using the first available bold font in the font list. Bold	249	foreground/background (default). See resource B<intensityStyles> for
129	fonts should thus be specified in the font list after their	250	details.
130	corresponding regular fonts. If no bold font can be found, a regular
131	font will be used. resource B<realBold>.
132		251
133	=item B<-name> I<name>	252	=item B<-name> I<name>
134		253
135	Specify the application name under which resources are to be obtained,	254	Specify the application name under which resources are to be obtained,
136	rather than the default executable file name. Name should not contain	255	rather than the default executable file name. Name should not contain
…		…
152		271
153	=item B<-sb>|B<+sb>	272	=item B<-sb>|B<+sb>
154		273
155	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
156		275
		276	=item B<-sr>|B<+sr>
		277
		278	Put scrollbar on right/left; resource B<scrollBar_right>.
		279
		280	=item B<-st>|B<+st>
		281
		282	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		283	resource B<scrollBar_floating>.
		284
157	=item B<-si>|B<+si>	285	=item B<-si>|B<+si>
158		286
159	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
160	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
161		289
…		…
168		296
169	Turn on/off scrolling with the scrollback buffer as new lines appear.	297	Turn on/off scrolling with the scrollback buffer as new lines appear.
170	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
171	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
172		300
173	=item B<-sr>|B<+sr>
174
175	Put scrollbar on right/left; resource B<scrollBar_right>.
176
177	=item B<-st>|B<+st>	301	=item B<-ptab>|B<+ptab>
178		302
179	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	303	If enabled (default), "Horizontal Tab" characters are being stored as
180	resource B<scrollBar_floating>.	304	actual wide characters in the screen buffer, which makes it possible to
		305	select and paste them. Since a horizontal tab is a cursor movement and
		306	not an actual glyph, this can sometimes be visually annoying as the cursor
		307	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
181		308
182	=item B<-bc>|B<+bc>	309	=item B<-bc>|B<+bc>
183		310
184	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
		312
		313	=item B<-uc>|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
185		316
186	=item B<-iconic>	317	=item B<-iconic>
187		318
188	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
189	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
…		…
206		337
207	=item B<-bl>	338	=item B<-bl>
208		339
209	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	340	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	341	if honoured by the WM, the rxvt-unicode window will not have window
211	decorations; resource B<borderLess>.	342	decorations; resource B<borderLess>. If the window manager does not
		343	support MWM hints (e.g. kwin), enables override-redirect mode.
		344
		345	=item B<-override-redirect>
		346
		347	Compile I<frills>: Sets override-redirect on the window; resource
		348	B<override-redirect>.
		349
		350	=item B<-sbg>
		351
		352	Compile I<frills>: Disable the usage of the built-in block graphics/line
		353	drawing characters and just rely on what the specified fonts provide. Use
		354	this if you have a good font and want to use its block graphic glyphs;
		355	resource B<skipBuiltinGlyphs>.
212		356
213	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
214		358
215	Compile I<linespace>: Lines (pixel height) to insert between each row	359	Compile I<frills>: Lines (pixel height) to insert between each row of
216	of the display; resource B<linespace>.	360	the display. Useful to work around font rendering problems; resource
		361	B<lineSpace>.
		362
		363	=item B<-letsp> I<number>
		364
		365	Compile I<frills>: Amount to adjust the computed character width by
		366	to control overall letter spacing. Negative values will tighten up the
		367	letter spacing, positive values will space letters out more. Useful to
		368	work around odd font metrics; resource B<letterSpace>.
217		369
218	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
219		371
220	This option specifies the name of the terminal type to be set in the	372	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	373	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	382	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	383	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,	384	run the program specified by the B<SHELL> environment variable or,
233	failing that, I<sh(1)>.	385	failing that, I<sh(1)>.
234		386
		387	Please note that you must specify a program with arguments. If you want to
		388	run shell commands, you have to specify the shell, like this:
		389
		390	@@RXVT_NAME@@ -e sh -c "shell commands"
		391
235	=item B<-title> I<text>	392	=item B<-title> I<text>
236		393
237	Window title (B<-T> still respected); the default title is the basename	394	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	395	of the program specified after the B<-e> option, if any, otherwise the
239	application name; resource B<title>.	396	application name; resource B<title>.
…		…
257		414
258	Compile I<XIM>: input method name. resource B<inputMethod>.	415	Compile I<XIM>: input method name. resource B<inputMethod>.
259		416
260	=item B<-imlocale> I<string>	417	=item B<-imlocale> I<string>
261		418
262	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	419	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	420	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	421	input extension to be able to input japanese characters while staying in
265	another locale.	422	another locale. resource B<imLocale>.
		423
		424	=item B<-imfont> I<fontset>
		425
		426	Set the font set to use for the X Input Method, see resource B<imFont>
		427	for more info.
		428
		429	=item B<-tcw>
		430
		431	Change the meaning of triple-click selection with the left mouse
		432	button. Only effective when the original (non-perl) selection code is
		433	in-use. Instead of selecting a full line it will extend the selection to
		434	the end of the logical line only. resource B<tripleclickwords>.
266		435
267	=item B<-insecure>	436	=item B<-insecure>
268		437
269	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
270	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
284	=item B<-ssr>|B<+ssr>	453	=item B<-ssr>|B<+ssr>
285		454
286	Turn on/off secondary screen scroll (default enabled); resource	455	Turn on/off secondary screen scroll (default enabled); resource
287	B<secondaryScroll>.	456	B<secondaryScroll>.
288		457
		458	=item B<-hold>|B<+hold>
		459
		460	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		461	will not immediately destroy its window when the program executed within
		462	it exits. Instead, it will wait till it is being killed or closed by the
		463	user; resource B<hold>.
		464
		465	=item B<-cd> I<path>
		466
		467	Sets the working directory for the shell (or the command specified via
		468	B<-e>). The I<path> must be an absolute path and it must exist for
		469	@@RXVT_NAME@@ to start; resource B<chdir>.
		470
289	=item B<-xrm> I<resourcestring>	471	=item B<-xrm> I<string>
290		472
291	No effect on rxvt-unicode. Simply passes through an argument to be made	473	Works like the X Toolkit option of the same name, by adding the I<string>
292	available in the instance's argument list. Appears in I<WM_COMMAND> in	474	as if it were specified in a resource file. Resource values specified this
293	some window managers.	475	way take precedence over all other resource specifications.
		476
		477	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		478	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		479	options can be specified as long-options on the commandline, so use
		480	of B<-xrm> is mostly limited to cases where you want to specify other
		481	resources (e.g. for input methods) or for compatibility with other
		482	programs.
		483
		484	=item B<-keysym.>I<sym> I<string>
		485
		486	Remap a key symbol. See resource B<keysym>.
		487
		488	=item B<-embed> I<windowid>
		489
		490	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		491	which enables applications to easily embed a terminal.
		492
		493	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		494	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		495	quite a bit, so don't expect it to keep some specific state. It's best to
		496	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		497
		498	The window will not be destroyed when @@RXVT_NAME@@ exits.
		499
		500	It might be useful to know that @@RXVT_NAME@@ will not close file
		501	descriptors passed to it (except for stdin/out/err, of course), so you
		502	can use file descriptors to communicate with the programs within the
		503	terminal. This works regardless of whether the C<-embed> option was used or
		504	not.
		505
		506	Here is a short Gtk2-perl snippet that illustrates how this option can be
		507	used (a longer example is in F<doc/embed>):
		508
		509	my $rxvt = new Gtk2::Socket;
		510	$rxvt->signal_connect_after (realize => sub {
		511	my $xid = $_[0]->window->get_xid;
		512	system "@@RXVT_NAME@@ -embed $xid &";
		513	});
		514
		515	=item B<-pty-fd> I<file descriptor>
		516
		517	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		518	pair but instead use the given file descriptor as the tty master. This is
		519	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		520	without having to run a program within it.
		521
		522	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		523	entries and will not tinker with pty/tty permissions - you have to do that
		524	yourself if you want that.
		525
		526	As an extremely special case, specifying C<-1> will completely suppress
		527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
		529
		530	Here is a example in perl that illustrates how this option can be used (a
		531	longer example is in F<doc/pty-fd>):
		532
		533	use IO::Pty;
		534	use Fcntl;
		535
		536	my $pty = new IO::Pty;
		537	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		538	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		539	close $pty;
		540
		541	# now communicate with rxvt
		542	my $slave = $pty->slave;
		543	while (<$slave>) { print $slave "got <$_>\n" }
		544
		545	=item B<-pe> I<string>
		546
		547	Comma-separated list of perl extension scripts to use (or not to use) in
		548	this terminal instance. See resource B<perl-ext> for details.
294		549
295	=back	550	=back
296		551
297	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
298		553
299	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
300	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
301		557
302	There are two different methods that @@RXVT_NAME@@ can use to get the	558	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	559	distribution do also load settings from the B<~/.Xresources> file when X
304	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	560	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	561	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		562
309	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	563	1. system-wide app-defaults file, either locale-dependent OR global
310	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	564	2. app-defaults file in $XAPPLRESDIR
311	set in XAPPLOADDIR/URxvt (compile-time defined: usually	565	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
312	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	566	4. SCREEN_RESOURCES for the current screen
313	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
		569
314	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	570	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	571	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	572	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	573	configured, while the class name B<URxvt> allows resources unique to
318	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	574	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
319	shared between different B<@@RXVT_NAME@@> configurations. If no	575	configurations. If no resources are specified, suitable defaults will
320	resources are specified, suitable defaults will be used. Command-line	576	be used. Command-line arguments can be used to override resource
321	arguments can be used to override resource settings. The following	577	settings. The following resources are supported (you might want to
322	resources are allowed:	578	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		579	extensions not documented here):
323		580
324	=over 4	581	=over 4
		582
		583	=item B<depth:> I<bitdepth>
		584
		585	Compile I<xft>: Attempt to find a visual with the given bit depth;
		586	option B<-depth>.
		587
		588	=item B<buffered:> I<boolean>
		589
		590	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		591	On some card/driver combination enabling it slightly decreases
		592	performance, on most it greatly helps it. The slowdown is small, so it
		593	should normally be enabled.
325		594
326	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
327		596
328	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
329	option B<-geometry>.	598	option B<-geometry>.
…		…
343	Use the specified colour for the colour value I<n>, where 0-7	612	Use the specified colour for the colour value I<n>, where 0-7
344	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
345	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
346	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	615	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	616	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.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
		618
		619	Colours higher than 15 cannot be set using resources (yet), but can be
		620	changed using an escape command (see @@RXVT_NAME@@(7)).
		621
		622	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		623	88 colour support). Colours 80-87 are evenly spaces grey steps.
349		624
350	=item B<colorBD:> I<colour>	625	=item B<colorBD:> I<colour>
351		626
		627	=item B<colorIT:> I<colour>
		628
352	Use the specified colour to display bold characters when the foreground	629	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	630	foreground colour is the default. If font styles are not available
354	enabled.	631	(Compile I<styles>) and this option is unset, reverse video is used instead.
355		632
356	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
357		634
358	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
359	foreground colour is the default.	636	foreground colour is the default.
360		637
361	=item B<colorRV:> I<colour>	638	=item B<underlineColor:> I<colour>
362		639
		640	If set, use the specified colour as the colour for the underline
		641	itself. If unset, use the foreground colour.
		642
		643	=item B<highlightColor:> I<colour>
		644
363	Use the specified colour as the background for reverse video	645	If set, use the specified colour as the background for highlighted
364	characters.	646	characters. If unset, use reverse video.
		647
		648	=item B<highlightTextColor:> I<colour>
		649
		650	If set and highlightColor is set, use the specified colour as the
		651	foreground for highlighted characters.
365		652
366	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
367		654
368	Use the specified colour for the cursor. The default is to use the	655	Use the specified colour for the cursor. The default is to use the
369	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
376		663
377	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
378		665
379	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
380	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
381	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
382		669
383	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
384		671
385	B<True>: specify that jump scrolling should be used. When scrolling	672	B<True>: specify that jump scrolling should be used. When receiving lots
386	quickly, fewer screen updates are performed [default]; option B<-j>.	673	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		674	has been read, resulting in fewer updates while still displaying every
		675	received line; option B<-j>.
		676
387	B<False>: specify that smooth scrolling should be used; option B<+j>.	677	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		678	force a screen refresh on each new line it received; option B<+j>.
388		679
389	=item B<inheritPixmap:> I<boolean>	680	=item B<skipScroll:> I<boolean>
390		681
391	B<True>: make the background inherit the parent windows' pixmap, giving	682	B<True>: (the default) specify that skip scrolling should be used. When
392	artificial transparency. B<False>: do not inherit the parent windows'	683	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
393	pixmap.	684	(around 60 times per second), resulting in far fewer updates. This can
		685	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		686	option B<-ss>.
		687
		688	B<False>: specify that everything is to be displayed, even
		689	if the refresh is too fast for the human eye to read anything (or the
		690	monitor to display anything); option B<+ss>.
		691
		692	=item B<transparent:> I<boolean>
		693
		694	Turn on/off pseudo-transparency by using the root pixmap as background.
		695
		696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		697	future versions.
394		698
395	=item B<fading:> I<number>	699	=item B<fading:> I<number>
396		700
397	Fade the text by the given percentage when focus is lost.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
		702
		703	=item B<fadeColor:> I<colour>
		704
		705	Fade to this colour, when fading is used (see B<fading:>). The default
		706	colour is black; option B<-fadecolor>.
398		707
399	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
400		709
401	Tint the transparent background pixmap with the given colour.	710	Tint the transparent background with the given colour. If the RENDER
		711	extension is not available only black, red, green, yellow, blue,
		712	magenta, cyan and white tints can be performed server-side. Note that
		713	a black tint yields a completely black image while a white tint yields
		714	the image unchanged; option B<-tint>.
402		715
403	=item B<shading:> I<number>	716	=item B<shading:> I<number>
404		717
405	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
406	image in addition to tinting it.	719	A value of 100 means no shading; option B<-sh>.
407		720
		721	=item B<blendType:> I<string>
		722
		723	Specify background blending type; option B<-blt>.
		724
408	=item B<fading:> I<number>	725	=item B<blurRadius:> I<number>
409		726
410	Scale the tint colour by the given percentage.	727	Apply gaussian blur with the specified radius to the transparent
		728	background; option B<-blr>.
		729
		730	=item B<iconFile:> I<file>
		731
		732	Set the application icon pixmap; option B<-icon>.
411		733
412	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
413		735
414	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
415		737
416	=item B<troughColor:> I<colour>	738	=item B<troughColor:> I<colour>
417		739
418	Use the specified colour for the scrollbar's trough area [default	740	Use the specified colour for the scrollbar's trough area [default
419	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	741	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
420		742
		743	=item B<borderColor:> I<colour>
		744
		745	The colour of the border around the text area and between the scrollbar
		746	and the text.
		747
421	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
422		749
423	Use the specified XPM file (note the `.xpm' extension is optional) for	750	Use the specified image file for the background and also
424	the background and also optionally specify its scaling with a geometry	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
425	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	752	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
426	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
427	centre (percent). A scale of 0 displays the image with tiling. A scale	754	centre (percent). A scale of 0 displays the image with tiling.
428	of 1 displays the image without any scaling. A scale of 2 to 9	755	The maximum permitted scale is 1000.
429	specifies an integer number of images in that direction. No image will	756	Additional operations can be specified after colon B<:op1:op2...>.
430	be magnified beyond 10 times its original size. The maximum permitted	757	Supported operations are:
431	scale is 1000. [default 0x0+50+50]
432		758
433	=item B<menu:> I<file[;tag]>	759	tile force background image to be tiled and not scaled. Equivalent to 0x0
		760	propscale will scale image keeping proportions
		761	auto will scale image to match window size. Equivalent to 100x100
		762	hscale will scale image horizontally to the window size
		763	vscale will scale image vertically to the window size
		764	scale will scale image to match window size
		765	root will tile image as if it was a root window background, auto-adjusting
		766	whenever terminal window moves
434		767
435	Read in the specified menu file (note the `.menu' extension is	768	If used in conjunction with B<-tr> option, the specified pixmap will be
436	optional) and also optionally specify a starting tag to find. See the	769	blended over the transparent background using alpha-blending. If I<afterimage>
437	reference documentation for details on the syntax for the menuBar.	770	support has been compiled in it is possible to choose other blending
		771	types with B<-blt "type"> option.
438		772
439	=item B<path:> I<path>	773	=item B<path:> I<path>
440		774
441	Specify the colon-delimited search path for finding files (XPM and	775	Specify the colon-delimited search path for finding background image files.
442	menus), in addition to the paths specified by the B<RXVTPATH> and
443	B<PATH> environment variables.
444		776
445	=item B<font:> I<fontname>	777	=item B<font:> I<fontlist>
446		778
447	Select the fonts to be used. This is a comma seperated list of font	779	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.	780	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	781	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	782	smaller, but not (in general) larger. A (hopefully) reasonable default
451	appended to it. option B<-fn>.	783	font list is always appended to it; option B<-fn>.
452		784
453	=item B<realBold:> I<boolean>	785	Each font can either be a standard X11 core font (XLFD) name, with
		786	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
454		787
455	B<True>: Enable "real bold" support. When this option is on, bold text	788	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.	789	specifications enclosed in square brackets (C<[]>). The only available
457	Bold fonts should thus be specified in the font list after their	790	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	791	fonts.
459	font will be used. option B<-rb>. B<False>: Display bold text in a
460	regular font, using the color specified with B<colorBD>; option B<+rb>.
461		792
462	=item B<selectstyle:> I<mode>	793	For example, this font resource
463		794
464	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	795	URxvt.font: 9x15bold,\
465	xterm style with 2.20 old word selection, or anything else which gives	796	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
466	xterm style selection.	797	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		798	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		799	xft:Code2000:antialias=false
467		800
468	=item B<scrollstyle:> I<mode>	801	specifies five fonts to be used. The first one is C<9x15bold> (actually
		802	the iso8859-1 version of the second font), which is the base font (because
		803	it is named first) and thus defines the character cell grid to be 9 pixels
		804	wide and 15 pixels high.
469		805
470	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	806	The second font is just used to add additional unicode characters not in
471	the author's favourite..	807	the base font, likewise the third, which is unfortunately non-bold, but
		808	the bold version of the font does contain fewer characters, so this is a
		809	useful supplement.
		810
		811	The third font is an Xft font with aliasing turned off, and the characters
		812	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		813	contains other characters, but we are not interested in them.
		814
		815	The last font is a useful catch-all font that supplies most of the
		816	remaining unicode characters.
		817
		818	=item B<boldFont:> I<fontlist>
		819
		820	=item B<italicFont:> I<fontlist>
		821
		822	=item B<boldItalicFont:> I<fontlist>
		823
		824	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		825	italic> >> characters, respectively.
		826
		827	If specified and non-empty, then the syntax is the same as for the
		828	B<font>-resource, and the given font list will be used as is, which makes
		829	it possible to substitute completely different font styles for bold and
		830	italic.
		831
		832	If unset (the default), a suitable font list will be synthesized by
		833	"morphing" the normal text font list into the desired shape. If that is
		834	not possible, replacement fonts of the desired shape will be tried.
		835
		836	If set, but empty, then this specific style is disabled and the normal
		837	text font will being used for the given style.
		838
		839	=item B<intensityStyles:> I<boolean>
		840
		841	When font styles are not enabled, or this option is enabled (B<True>,
		842	option B<-is>, the default), bold/blink font styles imply high
		843	intensity foreground/background colours. Disabling this option (B<False>,
		844	option B<+is>) disables this behaviour, the high intensity colours are not
		845	reachable.
472		846
473	=item B<title:> I<string>	847	=item B<title:> I<string>
474		848
475	Set window title string, the default title is the command-line	849	Set window title string, the default title is the command-line
476	specified after the B<-e> option, if any, otherwise the application	850	specified after the B<-e> option, if any, otherwise the application
…		…
485	=item B<mapAlert:> I<boolean>	859	=item B<mapAlert:> I<boolean>
486		860
487	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	861	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].	862	de-iconify (map) on receipt of a bell character [default].
489		863
		864	=item B<urgentOnBell:> I<boolean>
		865
		866	B<True>: set the urgency hint for the wm on receipt of a bell character.
		867	B<False>: do not set the urgency hint [default].
		868
		869	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		870
490	=item B<visualBell:> I<boolean>	871	=item B<visualBell:> I<boolean>
491		872
492	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	873	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
493	B<False>: no visual bell [default]; option B<+vb>.	874	B<False>: no visual bell [default]; option B<+vb>.
494		875
…		…
508		889
509	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	890	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	891	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.	892	B<Shift-Print> to include the scrollback as well.
512		893
		894	The string will be interpreted as if typed into the shell as-is.
		895
		896	Example:
		897
		898	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		899
		900	This creates a new file in your home directory with the screen contents
		901	every time you hit C<Print>.
		902
		903	=item B<scrollstyle:> I<mode>
		904
		905	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		906	the author's favourite.
		907
513	=item B<scrollBar:> I<boolean>	908	=item B<scrollBar:> I<boolean>
514		909
515	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	910	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
516	disable the scrollbar; option B<+sb>.	911	disable the scrollbar; option B<+sb>.
517		912
…		…
536	B<False>: do not scroll to bottom when tty receives output; option	931	B<False>: do not scroll to bottom when tty receives output; option
537	B<+si>.	932	B<+si>.
538		933
539	=item B<scrollWithBuffer:> I<boolean>	934	=item B<scrollWithBuffer:> I<boolean>
540		935
541	B<True>: scroll with scrollback buffer when tty recieves new lines (and	936	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	937	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
543	with scrollback buffer when tty recieves new lines; option B<-sw>.	938	with scrollback buffer when tty receives new lines; option B<+sw>.
544		939
545	=item B<scrollTtyKeypress:> I<boolean>	940	=item B<scrollTtyKeypress:> I<boolean>
546		941
547	B<True>: scroll to bottom when a non-special key is pressed. Special keys	942	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	943	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	944	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>.	945	bottom when a non-special key is pressed; option B<+sk>.
551		946
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>	947	=item B<saveLines:> I<number>
563		948
564	Save I<number> lines in the scrollback buffer [default 64]. This	949	Save I<number> lines in the scrollback buffer [default 64]. This
565	resource is limited on most machines to 65535; option B<-sl>.	950	resource is limited on most machines to 65535; option B<-sl>.
566		951
…		…
577	=item B<borderLess:> I<boolean>	962	=item B<borderLess:> I<boolean>
578		963
579	Set MWM hints to request a borderless window, i.e. if honoured by the	964	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>.	965	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
581		966
		967	=item B<skipBuiltinGlyphs:> I<boolean>
		968
		969	Compile I<frills>: Disable the usage of the built-in block graphics/line
		970	drawing characters and just rely on what the specified fonts provide. Use
		971	this if you have a good font and want to use its block graphic glyphs;
		972	option B<-sbg>.
		973
582	=item B<termName:> I<termname>	974	=item B<termName:> I<termname>
583		975
584	Specifies the terminal type name to be set in the B<TERM> environment	976	Specifies the terminal type name to be set in the B<TERM> environment
585	variable; option B<-tn>.	977	variable; option B<-tn>.
586		978
587	=item B<linespace:> I<number>	979	=item B<lineSpace:> I<number>
588		980
589	Specifies number of lines (pixel height) to insert between each row of	981	Specifies number of lines (pixel height) to insert between each row of
590	the display [default 0]; option B<-lsp>.	982	the display [default 0]; option B<-lsp>.
591		983
592	=item B<meta8:> I<boolean>	984	=item B<meta8:> I<boolean>
…		…
597	=item B<mouseWheelScrollPage:> I<boolean>	989	=item B<mouseWheelScrollPage:> I<boolean>
598		990
599	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	991	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
600	scrolls five lines [default].	992	scrolls five lines [default].
601		993
		994	=item B<pastableTabs:> I<boolean>
		995
		996	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		997	movement only; option C<-ptab>.
		998
602	=item B<cursorBlink:> I<boolean>	999	=item B<cursorBlink:> I<boolean>
603		1000
604	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1001	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
605	option B<-bc>.	1002	option B<-bc>.
		1003
		1004	=item B<cursorUnderline:> I<boolean>
		1005
		1006	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1007	option B<-uc>.
606		1008
607	=item B<pointerBlank:> I<boolean>	1009	=item B<pointerBlank:> I<boolean>
608		1010
609	B<True>: blank the pointer when a key is pressed or after a set number	1011	B<True>: blank the pointer when a key is pressed or after a set number
610	of seconds of inactivity. B<False>: the pointer is always visible	1012	of seconds of inactivity. B<False>: the pointer is always visible
…		…
618		1020
619	Mouse pointer background colour.	1021	Mouse pointer background colour.
620		1022
621	=item B<pointerBlankDelay:> I<number>	1023	=item B<pointerBlankDelay:> I<number>
622		1024
623	Specifies number of seconds before blanking the pointer [default 2].	1025	Specifies number of seconds before blanking the pointer [default 2]. Use a
		1026	large number (e.g. C<987654321>) to effectively disable the timeout.
624		1027
625	=item B<backspacekey:> I<string>	1028	=item B<backspacekey:> I<string>
626		1029
627	The string to send when the backspace key is pressed. If set to B<DEC>	1030	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>	1031	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
629	(code 8) - which can be reversed with the appropriate DEC private mode	1032	(code 8) - which can be reversed with the appropriate DEC private mode
630	escape sequence.	1033	escape sequence.
631		1034
632	=item B<deletekey:> I<string>	1035	=item B<deletekey:> I<string>
633		1036
…		…
635	pressed. If unset it will send the sequence traditionally associated	1038	pressed. If unset it will send the sequence traditionally associated
636	with the B<Execute> key.	1039	with the B<Execute> key.
637		1040
638	=item B<cutchars:> I<string>	1041	=item B<cutchars:> I<string>
639		1042
640	The characters used as delimiters for double-click word selection. The	1043	The characters used as delimiters for double-click word selection
641	built-in default:	1044	(whitespace delimiting is added automatically if resource is given).
642		1045
		1046	When the perl selection extension is in use (the default if compiled
		1047	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1048	characters will be created (if the resource exists, otherwise, no regex
		1049	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1050
		1051	When the selection extension is not used, only ISO-8859-1 characters can
		1052	be used. If not specified, the built-in default is used:
		1053
643	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1054	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
644		1055
645	=item B<preeditType:> I<style>	1056	=item B<preeditType:> I<style>
646		1057
647	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1058	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
648		1059
…		…
650		1061
651	I<name> of inputMethod to use; option B<-im>.	1062	I<name> of inputMethod to use; option B<-im>.
652		1063
653	=item B<imLocale:> I<name>	1064	=item B<imLocale:> I<name>
654		1065
655	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	1066	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	1067	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	1068	input extension to be able to input japanese characters while staying in
658	another locale. option B<-imlocale>.	1069	another locale; option B<-imlocale>.
659		1070
660	=item B<insecure>	1071	=item B<imFont:> I<fontset>
		1072
		1073	Specify the font-set used for XIM styles C<OverTheSpot> or
		1074	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		1075	by commas), i.e. it's not in the same format as the other font lists used
		1076	in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
		1077	found, preferably one or two pixels differing in size to the base font.
		1078	option B<-imfont>.
		1079
		1080	=item B<tripleclickwords:> I<boolean>
		1081
		1082	Change the meaning of triple-click selection with the left mouse
		1083	button. Instead of selecting a full line it will extend the selection to
		1084	the end of the logical line only; option B<-tcw>.
		1085
		1086	=item B<insecure:> I<boolean>
661		1087
662	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1088	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
663	echo arbitrary strings like the icon name or the locale. This could be	1089	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	1090	abused if somebody gets 8-bit-clean access to your display, whether
665	throuh a mail client displaying mail bodies unfiltered or though	1091	through a mail client displaying mail bodies unfiltered or through
666	write(1). Therefore, these sequences are disabled by default. (Note	1092	write(1) or any other means. Therefore, these sequences are disabled by
667	that other terminals, including xterm, have these sequences	1093	default. (Note that many other terminals, including xterm, have these
668	enabled by default). You can enable them by setting this boolean	1094	sequences enabled by default, which doesn't make it safer, though).
669	resource or specifying B<-insecure> as an option. At the moment, this	1095
670	enabled display-answer, locale, findfont, icon label and window title	1096	You can enable them by setting this boolean resource or specifying
671	requests as well as dynamic menubar dispatch.	1097	B<-insecure> as an option. At the moment, this enables display-answer,
		1098	locale, findfont, icon label and window title requests.
672		1099
673	=item B<modifier:> I<modifier>	1100	=item B<modifier:> I<modifier>
674		1101
675	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1102	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	1103	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
680		1107
681	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1108	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	1109	character is passed through. It may contain escape values as described
683	in the entry on B<keysym> following.	1110	in the entry on B<keysym> following.
684		1111
685	=item B<secondaryScreen:> I<bool>	1112	=item B<secondaryScreen:> I<boolean>
686		1113
687	Turn on/off secondary screen (default enabled).	1114	Turn on/off secondary screen (default enabled).
688		1115
689	=item B<secondaryScroll:> I<bool>	1116	=item B<secondaryScroll:> I<boolean>
690		1117
691	Turn on/off secondary screen scroll (default enabled). If the this	1118	Turn on/off secondary screen scroll (default enabled). If this
692	option is enabled, scrolls on the secondary screen will change the	1119	option is enabled, scrolls on the secondary screen will change the
693	scrollback buffer and switching to/from the secondary screen will	1120	scrollback buffer and, when secondaryScreen is off, switching
694	instead scroll the screen up.	1121	to/from the secondary screen will instead scroll the screen up.
		1122
		1123	=item B<hold>: I<boolean>
		1124
		1125	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1126	will not immediately destroy its window when the program executed within
		1127	it exits. Instead, it will wait till it is being killed or closed by the
		1128	user.
		1129
		1130	=item B<chdir>: I<path>
		1131
		1132	Sets the working directory for the shell (or the command specified via
		1133	B<-e>). The I<path> must be an absolute path and it must exist for
		1134	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1135	directory will be used; option B<-cd>.
695		1136
696	=item B<keysym.>I<sym>: I<string>	1137	=item B<keysym.>I<sym>: I<string>
697		1138
698	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1139	Compile I<frills>: Associate I<string> with keysym I<sym>. The
699	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
700	newline, \r: return, \t:
701	tab, \000: octal number) or control characters (^?: delete, ^@: null,
702	^A ...) and may enclosed with double quotes so that it can start or end
703	with whitespace. The intervening resource name B<keysym.> cannot be	1140	intervening resource name B<keysym.> cannot be omitted.
704	omitted. This resource is only available when compiled with	1141
705	KEYSYM_RESOURCE.	1142	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		1143	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		1144	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1145	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1146	B<2>, B<3>, B<4>, B<5>.
		1147
		1148	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1149	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1150	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1151	current application keymap mode state.
		1152
		1153	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1154	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1155	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1156	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1157	performed in an exact manner; however, the closest match is assured.
		1158
		1159	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
		1160	number), see RESOURCES in C<man 7 X> for further details.
		1161
		1162	You can define a range of keysyms in one shot by providing a I<string>
		1163	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
		1164	should be a character not used by the strings.
		1165
		1166	Its usage can be demonstrated by an example:
		1167
		1168	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
		1169
		1170	The above line is equivalent to the following three lines:
		1171
		1172	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1173	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1174	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1175
		1176	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1177	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1178	example the following means "change the current locale to C<zh_CN.GBK>
		1179	when Control-Meta-c is being pressed":
		1180
		1181	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1182
		1183	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1184	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1185	manpage. For example, the F<selection> extension (activated via
		1186	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1187
		1188	URxvt.keysym.M-C-c: perl:selection:rot13
		1189
		1190	Due the the large number of modifier combinations, a defined key mapping
		1191	will match if I<at least> the specified identifiers are being set, and
		1192	no other key mappings with those and more bits are being defined. That
		1193	means that defining a key map for C<a> will automatically provide
		1194	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1195	mappings themselves.
		1196
		1197	Unfortunately, this will override built-in key mappings. For example
		1198	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1199	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1200	user-defined keymap using the C<builtin:> replacement:
		1201
		1202	URxvt.keysym.Insert: <my insert key sequence>
		1203	URxvt.keysym.S-Insert: builtin:
		1204
		1205	The first line defines a mapping for C<Insert> and I<any> combination
		1206	of modifiers. The second line re-establishes the default mapping for
		1207	C<Shift-Insert>.
		1208
		1209	The following example will map Control-Meta-1 and Control-Meta-2 to
		1210	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1211	font-switching at runtime:
		1212
		1213	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1214	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1215
		1216	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1217	info):
		1218
		1219	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1220	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1221
		1222	=item B<perl-ext-common>: I<string>
		1223
		1224	=item B<perl-ext>: I<string>
		1225
		1226	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1227	use in this terminal instance; option B<-pe>.
		1228
		1229	Extension names can be prefixed with a C<-> sign to prohibit using
		1230	them. This can be useful to selectively disable some extensions loaded
		1231	by default, or specified via the C<perl-ext-common> resource. For
		1232	example, C<default,-selection> will use all the default extension except
		1233	C<selection>.
		1234
		1235	Extension names can also be followed by an argument in angle brackets
		1236	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1237	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1238	multiple times with different arguments will pass multiple arguments to
		1239	the extension.
		1240
		1241	Each extension is looked up in the library directories, loaded if
		1242	necessary, and bound to the current terminal instance.
		1243
		1244	If both of these resources are the empty string, then the perl
		1245	interpreter will not be initialized. The idea behind two options is that
		1246	B<perl-ext-common> will be used for extensions that should be available to
		1247	all instances, while B<perl-ext> is used for specific instances.
		1248
		1249	=item B<perl-eval>: I<string>
		1250
		1251	Perl code to be evaluated when all extensions have been registered. See
		1252	the @@RXVT_NAME@@perl(3) manpage.
		1253
		1254	=item B<perl-lib>: I<path>
		1255
		1256	Colon-separated list of additional directories that hold extension
		1257	scripts. When looking for extensions specified by the C<perl> resource,
		1258	@@RXVT_NAME@@ will first look in these directories and then in
		1259	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1260
		1261	See the @@RXVT_NAME@@perl(3) manpage.
		1262
		1263	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1264
		1265	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1266	details.
		1267
		1268	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1269
		1270	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1271	for details.
		1272
		1273	=item B<searchable-scrollback:> I<keysym>
		1274
		1275	Sets the hotkey that starts the incremental scrollback buffer search
		1276	(default: C<M-s>).
		1277
		1278	=item B<urlLauncher>: I<string>
		1279
		1280	Specifies the program to be started with a URL argument. Used by the
		1281	C<selection-popup> and C<matcher> perl extensions.
		1282
		1283	=item B<transient-for>: I<windowid>
		1284
		1285	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1286
		1287	=item B<override-redirect>: I<boolean>
		1288
		1289	Compile I<frills>: Sets override-redirect for the terminal window, making
		1290	it almost invisible to window managers; option B<-override-redirect>.
		1291
		1292	=item B<iso14755:> I<boolean>
		1293
		1294	Turn on/off ISO 14755 (default enabled).
		1295
		1296	=item B<iso14755_52:> I<boolean>
		1297
		1298	Turn on/off ISO 14755 5.2 mode (default enabled).
706		1299
707	=back	1300	=back
708		1301
709	=head1 THE SCROLLBAR	1302	=head1 THE SCROLLBAR
710		1303
…		…
724	the normal text selection/insertion, hold either the Shift or the Meta	1317	the normal text selection/insertion, hold either the Shift or the Meta
725	(Alt) key while performing the desired mouse action.	1318	(Alt) key while performing the desired mouse action.
726		1319
727	If mouse reporting mode is active, the normal scrollbar actions are	1320	If mouse reporting mode is active, the normal scrollbar actions are
728	disabled -- on the assumption that we are using a fullscreen	1321	disabled -- on the assumption that we are using a fullscreen
729	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1322	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
730	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1323	(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),	1324	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
732	respectively.	1325	respectively.
733		1326
734	=head1 TEXT SELECTION AND INSERTION	1327	=head1 THE SELECTION: SELECTING AND PASTING TEXT
735		1328
736	The behaviour of text selection and insertion mechanism is similar to	1329	The behaviour of text selection and insertion/pasting mechanism is similar
737	I<xterm>(1).	1330	to I<xterm>(1).
738		1331
739	=over 4	1332	=over 4
740		1333
741	=item B<Selection>:	1334	=item B<Selecting>:
742		1335
743	Left click at the beginning of the region, drag to the end of the	1336	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	1337	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	1338	to select a word; Left triple-click to select the entire logical line
746	line.	1339	(which can span multiple screen lines), unless modified by resource
		1340	B<tripleclickwords>.
747		1341
		1342	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1343	(Compile: I<frills>) will create a rectangular selection instead of a
		1344	normal one. In this mode, every selected row becomes its own line in the
		1345	selection, and trailing whitespace is visually underlined and removed from
		1346	the selection.
		1347
748	=item B<Insertion>:	1348	=item B<Pasting>:
749		1349
750	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1350	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	1351	window causes the value of the PRIMARY selection (or CLIPBOARD with the
752	inserted as if it had been typed on the keyboard.	1352	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1353
		1354	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1355	inserted too.
753		1356
754	=back	1357	=back
755		1358
756	=head1 CHANGING FONTS	1359	=head1 CHANGING FONTS
757		1360
758	You can change fonts on-the-fly, which is to say cycle through the	1361	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	1362	supported in rxvt-unicode. Bug me if you need this.
760	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1363
761	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1364	You can, however, switch fonts at runtime using escape sequences, e.g.:
762	actual key can be selected using resources	1365
763	B<smallfont_key>/B<bigfont_key>.	1366	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1367
		1368	You can use keyboard shortcuts, too:
		1369
		1370	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1371	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
		1372
		1373	rxvt-unicode will automatically re-apply these fonts to the output so far.
764		1374
765	=head1 ISO 14755 SUPPORT	1375	=head1 ISO 14755 SUPPORT
766		1376
767	Partial ISO 14755-support is implemented. that means that pressing	1377	ISO 14755 is a standard for entering and viewing unicode characters
		1378	and character codes using the keyboard. It consists of 4 parts. The
		1379	first part is available if rxvt-unicode has been compiled with
		1380	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1381	with C<--enable-iso14755>.
768		1382
769	Section 5.1: Control and Shift together enters unicode input	1383	=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		1384
774	Section 5.2: Pressing and immediately releasing Control and Shift together	1385	=item * 5.1: Basic method
775	enters keycap entry mode for the next key: pressing a function key (tab,	1386
776	return etc..) will enter the unicode character corresponding to the given	1387	This allows you to enter unicode characters using their hexcode.
777	key.	1388
		1389	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1390	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1391	commit the character as if it were typed directly. While holding down
		1392	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1393	C<Space>, which will commit the current character and lets you start a new
		1394	one.
		1395
		1396	As an example of use, imagine a business card with a japanese e-mail
		1397	address, which you cannot type. Fortunately, the card has the e-mail
		1398	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1399	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1400	followed by releasing the modifier keys.
		1401
		1402	=item * 5.2: Keyboard symbols entry method
		1403
		1404	This mode lets you input characters representing the keycap symbols of
		1405	your keyboard, if representable in the current locale encoding.
		1406
		1407	Start by pressing C<Control> and C<Shift> together, then releasing
		1408	them. The next special key (cursor keys, home etc.) you enter will not
		1409	invoke its usual function but instead will insert the corresponding
		1410	keycap symbol. The symbol will only be entered when the key has been
		1411	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1412	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1413	reverse tab (Shift-Tab).
		1414
		1415	=item * 5.3: Screen-selection entry method
		1416
		1417	While this is implemented already (it's basically the selection
		1418	mechanism), it could be extended by displaying a unicode character map.
		1419
		1420	=item * 5.4: Feedback method for identifying displayed characters for later input
		1421
		1422	This method lets you display the unicode character code associated with
		1423	characters already displayed.
		1424
		1425	You enter this mode by holding down C<Control> and C<Shift> together, then
		1426	pressing and holding the left mouse button and moving around. The unicode
		1427	hex code(s) (it might be a combining character) of the character under the
		1428	pointer is displayed until you release C<Control> and C<Shift>.
		1429
		1430	In addition to the hex codes it will display the font used to draw this
		1431	character - due to implementation reasons, characters combined with
		1432	combining characters, line drawing characters and unknown characters will
		1433	always be drawn using the built-in support font.
		1434
		1435	=back
		1436
		1437	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1438	both scenario A and B of ISO 14755, including part 5.2.
778		1439
779	=head1 LOGIN STAMP	1440	=head1 LOGIN STAMP
780		1441
781	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1442	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.	1443	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	1444	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
784	some systems.	1445	on some systems or setgid to root or to some other group on others.
785		1446
786	=head1 COLORS AND GRAPHICS	1447	=head1 COLOURS AND GRAPHICS
787		1448
788	In addition to the default foreground and background colours,	1449	In addition to the default foreground and background colours,
789	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1450	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
790	high-intensity bold/blink versions of the same). Here is a list of the	1451	high-intensity (potentially bold/blink) versions of the same, and 72 (or
791	colours with their B<rgb.txt> names.	1452	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1453	cube plus a 8 (24) colour greyscale ramp.
		1454
		1455	Here is a list of the ANSI colours with their names.
792		1456
793	=begin table	1457	=begin table
794		1458
795	B<color0> (black) = Black	1459	B<color0> (black) = Black
796	B<color1> (red) = Red3	1460	B<color1> (red) = Red3
…		…
816	It is also possible to specify the colour values of B<foreground>,	1480	It is also possible to specify the colour values of B<foreground>,
817	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1481	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	1482	a number 0-15, as a convenient shorthand to reference the colour name of
819	color0-color15.	1483	color0-color15.
820		1484
		1485	The following text gives values for the standard 88 colour mode (and
		1486	values for the 256 colour mode in parentheses).
		1487
		1488	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1489
		1490	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1491	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1492
		1493	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1494	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1495	the RGB cube.
		1496
		1497	Together, all those colours implement the 88 (256) colour xterm
		1498	colours. Only the first 16 can be changed using resources currently, the
		1499	rest can only be changed via command sequences ("escape codes").
		1500
		1501	Applications are advised to use terminfo or command sequences to discover
		1502	number and RGB values of all colours (yes, you can query this...).
		1503
821	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1504	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
822	always swapping the foreground/background colours. This is in contrast to	1505	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	1506	I<xterm>(1) where the colours are only swapped if they have not otherwise
824	been specified. For example,	1507	been specified. For example,
825		1508
		1509	@@RXVT_NAME@@ -fg Black -bg White -rv
		1510
		1511	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1512	White.
		1513
		1514	=head2 ALPHA CHANNEL SUPPORT
		1515
		1516	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1517	their act together, rxvt-unicode will do it's own alpha channel management:
		1518
		1519	You can prefix any colour with an opaqueness percentage enclosed in
		1520	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1521	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1522	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1523	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1524	is the recommended format to specify transparency values, and works with
		1525	all ways to specify a colour.
		1526
		1527	For complete control, rxvt-unicode also supports
		1528	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1529	specifications, where the additional C<aaaa> component specifies opacity
		1530	(alpha) values. The minimum value of C<0000> is completely transparent,
		1531	while C<ffff> is completely opaque). The two example colours from
		1532	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1533	C<rgba:0000/ff00/0000/f332>.
		1534
		1535	You probably need to specify B<"-depth 32">, too, to force a visual with
		1536	alpha channels, and have the luck that your X-server uses ARGB pixel
		1537	layout, as X is far from just supporting ARGB visuals out of the box, and
		1538	rxvt-unicode just fudges around.
		1539
		1540	For example, the following selects an almost completely transparent black
		1541	background, and an almost opaque pink foreground:
		1542
		1543	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1544
		1545	When not using a background image, then the interpretation of the
		1546	alpha channel is up to your compositing manager (most interpret it as
		1547	transparency of course).
		1548
		1549	When using a background pixmap or pseudo-transparency, then the background
		1550	colour will always behave as if it were completely transparent (so the
		1551	background image shows instead), regardless of how it was specified, while
		1552	other colours will either be transparent as specified (the background
		1553	image will show through) on servers supporting the RENDER extension, or
		1554	fully opaque on servers not supporting the RENDER EXTENSION.
		1555
		1556	Please note that due to bugs in Xft, specifying alpha values might result
		1557	in garbage being displayed when the X-server does not support the RENDER
		1558	extension.
		1559
		1560	=head1 ENVIRONMENT
		1561
		1562	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1563
826	=over 4	1564	=over 4
827		1565
828	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1566	=item B<TERM>
829		1567
830	would yield White on Black, while on I<xterm>(1) it would yield Black	1568	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
831	on White.	1569	resources or on the command line.
		1570
		1571	=item B<COLORTERM>
		1572
		1573	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1574	compiled with background image support, and optionally with the added
		1575	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1576	screen.
		1577
		1578	=item B<COLORFGBG>
		1579
		1580	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1581	the colour code used as default foreground/text colour (or the string
		1582	C<default> to indicate that the default-colour escape sequence is to be
		1583	used), C<bg> is the colour code used as default background colour (or the
		1584	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1585	was compiled with background image support. Libraries like C<ncurses>
		1586	and C<slang> can (and do) use this information to optimize screen output.
		1587
		1588	=item B<WINDOWID>
		1589
		1590	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1591	window, which usually has subwindows for the scrollbar, the terminal
		1592	window and so on).
		1593
		1594	=item B<TERMINFO>
		1595
		1596	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1597	C<--with-terminfo=PATH>.
		1598
		1599	=item B<DISPLAY>
		1600
		1601	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1602	display in its child processes if C<-display> isn't used to override. It
		1603	defaults to C<:0> if it doesn't exist.
		1604
		1605	=item B<SHELL>
		1606
		1607	The shell to be used for command execution, defaults to C</bin/sh>.
		1608
		1609	=item B<RXVT_SOCKET>
		1610
		1611	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1612	@@RXVT_NAME@@d(1).
		1613
		1614	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
		1615
		1616	=item B<HOME>
		1617
		1618	Used to locate the default directory for the unix domain socket for
		1619	daemon communications and to locate various resource files (such as
		1620	C<.Xdefaults>)
		1621
		1622	=item B<XAPPLRESDIR>
		1623
		1624	Directory where application-specific X resource files are located.
		1625
		1626	=item B<XENVIRONMENT>
		1627
		1628	If set and accessible, gives the name of a X resource file to be loaded by
		1629	@@RXVT_NAME@@.
832		1630
833	=back	1631	=back
834		1632
835	=head1 ENVIRONMENT
836
837	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
838	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
839	window id number of the B<@@RXVT_NAME@@> window and it also uses and
840	sets the environment variable B<DISPLAY> to specify which display
841	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
842	B<RXVTPATH> and B<PATH> to find XPM files.
843
844	=head1 FILES	1633	=head1 FILES
845		1634
846	=over 4	1635	=over 4
847		1636
848	=item B</etc/utmp>
849
850	System file for login records.
851
852	=item B</usr/lib/X11/rgb.txt>	1637	=item B</usr/lib/X11/rgb.txt>
853		1638
854	Color names.	1639	Colour names.
855		1640
856	=back	1641	=back
857		1642
858	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1643	=head1 SEE ALSO
		1644
		1645	@@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)
		1646
		1647	=head1 CURRENT PROJECT COORDINATOR
859		1648
860	=over 4	1649	=over 4
861		1650
862	=item How do I know which rxvt-unicode version I'm using?	1651	=item Project Coordinator
863		1652
864	The version number is displayed with the usage (-h). For rxvt-unicode	1653	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		1654
868	=item Mouse cut/paste suddenly no longer works.	1655	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		1656
1077	=back	1657	=back
1078		1658
1079	=head1 SEE ALSO	1659	=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		1660
1093	=over 4	1661	=over 4
1094		1662
1095	=item Project Coordinator	1663	=item John Bovey
1096		1664
1097	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1665	University of Kent, 1992, wrote the original Xvt.
1098		1666
1099	=item Web page maintainter	1667	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>
1100		1668
1101	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>	1669	very heavily modified Xvt and came up with Rxvt
1102		1670
1103	L<@@RXVT_WEBPAGE@@>	1671	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>
		1672
		1673	wrote the Greek Keyboard Input (no longer in code)
		1674
		1675	=item mj olesen L<< <olesen@me.QueensU.CA> >>
		1676
		1677	Wrote the menu system.
		1678
		1679	Project Coordinator (changes.txt 2.11 to 2.21)
		1680
		1681	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>
		1682
		1683	Project Coordinator (changes.txt 2.21a to 2.4.5)
		1684
		1685	=item Geoff Wing L<< <gcw@pobox.com> >>
		1686
		1687	Rewrote screen display and text selection routines.
		1688
		1689	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
		1690
		1691	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
		1692
		1693	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
		1694	extension, random hacks, numerous bugfixes and extensions.
		1695
		1696	Project Coordinator (Changes 1.0 -)
		1697
		1698	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1699
		1700	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1104		1701
1105	=back	1702	=back
1106		1703
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