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.2 by root, Thu Aug 12 21:30:14 2004 UTC vs.
Revision 1.165 by root, Thu Oct 2 17:06:50 2008 UTC

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

Diff Legend

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