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

Diff Legend

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