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.36 by root, Wed Dec 15 05:10:57 2004 UTC vs.
Revision 1.250 by root, Sat Oct 10 20:06:45 2020 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	asked questions and answer to them and some common problems.	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>.
21		26
22	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
23		28
24	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
26	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
27	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
28	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
29	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
30	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
31	fine, though. A somewhat difficult case are left-to-right scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
32	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
33	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
34	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
35	change.	40	change.
36		41
37	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
38	me recommend C<mlterm>, which is a very userfriendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
39	terminal emulator. In fact, the reason rxvt-unicode was born was solely	44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
40	because the author couldn't get C<mlterm> to use one font for latin1 and	45	because the author couldn't get C<mlterm> to use one font for latin1 and
41	another for japanese.	46	another for japanese.
42		47
43	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
44	display characters: The idea of a single unicode font which many other	49	display characters: The idea of a single unicode font which many other
45	programs force onto it's users never made sense to me: You should be able	50	programs force onto its users never made sense to me: You should be able
46	to choose any font for any script freely.	51	to choose any font for any script freely.
47		52
48	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
49	it's predecessor, supports things such as XFT and ISO 14755 that are handy	54	its predecessor, supports things such as XFT and ISO 14755 that are handy
50	in i18n-environments, is faster, and has a lot less bugs than the original	55	in i18n-environments, is faster, and has a lot bugs less than the original
51	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
52		57
53	It is still faithfully following the original rxvt idea of being lean	58	It is still faithfully following the original rxvt idea of being lean
54	and nice on resources: for example, you can still configure rxvt-unicode	59	and nice on resources: for example, you can still configure rxvt-unicode
55	without most of it's features to get a lean binary. It also comes with	60	without most of its features to get a lean binary. It also comes with
56	a client/daemon pair that lets you open any number of terminal windows	61	a client/daemon pair that lets you open any number of terminal windows
57	from within a single process, which makes startup time very fast and	62	from within a single process, which makes startup time very fast and
58	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
60		65
61	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
62	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
63	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
64		69
65	=head1 OPTIONS	70	=head1 OPTIONS
66		71
67	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
…		…
87		92
88	Print out a message describing available options.	93	Print out a message describing available options.
89		94
90	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
91		96
92	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>
93	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
94	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.
95		116
96	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
97		118
98	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
99		120
…		…
101		122
102	Turn on/off simulated reverse video; resource B<reverseVideo>.	123	Turn on/off simulated reverse video; resource B<reverseVideo>.
103		124
104	=item B<-j>|B<+j>	125	=item B<-j>|B<+j>
105		126
106	Turn on/off jump scrolling; resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
107		128
108	=item B<-ip>|B<+ip>	129	=item B<-ss>|B<+ss>
109		130
110	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>.
111	B<-tr>; resource B<inheritPixmap>.
112		132
113	=item B<-fade> I<number>	133	=item B<-fade> I<number>
114		134
115	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>.
116		138
117	=item B<-tint> I<colour>	139	=item B<-fadecolor> I<colour>
118		140
119	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
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	142	is opaque black. resource B<fadeColor>.
121	option that can be used to brighten or darken the image in addition to
122	tinting it.
123		143
124	=item B<-sh>	144	=item B<-icon> I<file>
125		145
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	146	Compile I<pixbuf>: Use the specified image as application icon. This
127	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
128	specified, too, e.g. C<-tint white>).	148	application window; resource I<iconFile>.
129		149
130	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
131		151
132	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
133		153
134	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
135		155
136	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
137
138	=item B<-pixmap> I<file[;geom]>
139
140	Compile I<XPM>: Specify XPM file for the background and also optionally
141	specify its scaling with a geometry string. Note you may need to add
142	quotes to avoid special shell interpretation of the `;' in the
143	command-line; resource B<backgroundPixmap>.
144		157
145	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
146		159
147	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
148		161
…		…
160	resource B<borderColor>.	173	resource B<borderColor>.
161		174
162	=item B<-fn> I<fontlist>	175	=item B<-fn> I<fontlist>
163		176
164	Select the fonts to be used. This is a comma separated list of font names	177	Select the fonts to be used. This is a comma separated list of font names
165	that are used in turn when trying to display Unicode characters. The	178	that are checked in order when trying to find glyphs for characters. The
166	first font defines the cell size for characters; other fonts might be	179	first font defines the cell size for characters; other fonts might be
167	smaller, but not (in general) larger. A (hopefully) reasonable default	180	smaller, but not (in general) larger. A (hopefully) reasonable default
168	font list is always appended to it. See resource B<font> for more details.	181	font list is always appended to it. See resource B<font> for more details.
169		182
170	In short, to specify an X11 core font, just specify it's name or prefix it	183	In short, to specify an X11 core font, just specify its name or prefix it
171	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	184	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
172	e.g.:	185	e.g.:
173		186
174	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	187	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
175	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	188	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
177	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	190	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178	section of @@RXVT_NAME@@(7).	191	section of @@RXVT_NAME@@(7).
179		192
180	=item B<-fb> I<fontlist>	193	=item B<-fb> I<fontlist>
181		194
182	Compile font-styles: The bold font list to use when bold characters are to	195	Compile I<font-styles>: The bold font list to use when B<bold> characters
183	be printed. See resource B<boldFont> for details.	196	are to be printed. See resource B<boldFont> for details.
184		197
185	=item B<-fi> I<fontlist>	198	=item B<-fi> I<fontlist>
186		199
187	Compile font-styles: The italic font list to use when bold characters are to	200	Compile I<font-styles>: The italic font list to use when I<italic>
188	be printed. See resource B<italicFont> for details.	201	characters are to be printed. See resource B<italicFont> for details.
189		202
190	=item B<-fbi> I<fontlist>	203	=item B<-fbi> I<fontlist>
191		204
192	Compile font-styles: The bold italic font list to use when bold characters are to	205	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193	be printed. See resource B<boldItalicFont> for details.	206	italic> >> characters are to be printed. See resource B<boldItalicFont>
		207	for details.
		208
		209	=item B<-is>|B<+is>
		210
		211	Compile I<font-styles>: Bold/Blink font styles imply high intensity
		212	foreground/background (default). See resource B<intensityStyles> for
		213	details.
194		214
195	=item B<-name> I<name>	215	=item B<-name> I<name>
196		216
197	Specify the application name under which resources are to be obtained,	217	Specify the application name under which resources are to be obtained,
198	rather than the default executable file name. Name should not contain	218	rather than the default executable file name. Name should not contain
…		…
200		220
201	=item B<-ls>|B<+ls>	221	=item B<-ls>|B<+ls>
202		222
203	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
204		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
205	=item B<-ut>|B<+ut>	229	=item B<-ut>|B<+ut>
206		230
207	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
208	B<utmpInhibit>.	232	B<utmpInhibit>.
209		233
…		…
213	B<visualBell>.	237	B<visualBell>.
214		238
215	=item B<-sb>|B<+sb>	239	=item B<-sb>|B<+sb>
216		240
217	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>.
218		251
219	=item B<-si>|B<+si>	252	=item B<-si>|B<+si>
220		253
221	Turn on/off scroll-to-bottom on TTY output inhibit; resource	254	Turn on/off scroll-to-bottom on TTY output inhibit; resource
222	B<scrollTtyOutput> has opposite effect.	255	B<scrollTtyOutput> has opposite effect.
…		…
229	=item B<-sw>|B<+sw>	262	=item B<-sw>|B<+sw>
230		263
231	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.
232	This only takes effect if B<-si> is also given; resource	265	This only takes effect if B<-si> is also given; resource
233	B<scrollWithBuffer>.	266	B<scrollWithBuffer>.
234
235	=item B<-sr>|B<+sr>
236
237	Put scrollbar on right/left; resource B<scrollBar_right>.
238
239	=item B<-st>|B<+st>
240
241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
242	resource B<scrollBar_floating>.
243		267
244	=item B<-ptab>|B<+ptab>	268	=item B<-ptab>|B<+ptab>
245		269
246	If enabled (default), "Horizontal Tab" characters are being stored as	270	If enabled (default), "Horizontal Tab" characters are being stored as
247	actual wide characters in the screen buffer, which makes it possible to	271	actual wide characters in the screen buffer, which makes it possible to
…		…
251		275
252	=item B<-bc>|B<+bc>	276	=item B<-bc>|B<+bc>
253		277
254	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
255		279
		280	=item B<-uc>|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
		283
256	=item B<-iconic>	284	=item B<-iconic>
257		285
258	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
259	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
260		288
…		…
276		304
277	=item B<-bl>	305	=item B<-bl>
278		306
279	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.
280	if honoured by the WM, the rxvt-unicode window will not have window	308	if honoured by the WM, the rxvt-unicode window will not have window
281	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>.
282		328
283	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
284		330
285	Compile I<linespace>: Lines (pixel height) to insert between each row	331	Compile I<frills>: Lines (pixel height) to insert between each row of
286	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>.
287		341
288	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
289		343
290	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
291	B<TERM> environment variable. This terminal type must exist in the	345	B<TERM> environment variable. This terminal type must exist in the
…		…
300	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
301	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
302	run the program specified by the B<SHELL> environment variable or,	356	run the program specified by the B<SHELL> environment variable or,
303	failing that, I<sh(1)>.	357	failing that, I<sh(1)>.
304		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
305	=item B<-title> I<text>	364	=item B<-title> I<text>
306		365
307	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
308	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
309	application name; resource B<title>.	368	application name; resource B<title>.
…		…
321	=item B<-pt> I<style>	380	=item B<-pt> I<style>
322		381
323	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
324	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
325		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
326	=item B<-im> I<text>	388	=item B<-im> I<text>
327		389
328	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
329		391
330	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
331		393
332	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.
333	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
334	extension to be able to input japanese characters while staying in	396	input extension to be able to input japanese characters while staying in
335	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>.
336		410
337	=item B<-insecure>	411	=item B<-insecure>
338		412
339	Enable "insecure" mode, which currently enables most of the escape	413	Enable "insecure" mode, which currently enables most of the escape
340	sequences that echo strings. See the resource B<insecure> for more	414	sequences that echo strings. See the resource B<insecure> for more
…		…
354	=item B<-ssr>|B<+ssr>	428	=item B<-ssr>|B<+ssr>
355		429
356	Turn on/off secondary screen scroll (default enabled); resource	430	Turn on/off secondary screen scroll (default enabled); resource
357	B<secondaryScroll>.	431	B<secondaryScroll>.
358		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
359	=item B<-xrm> I<resourcestring>	446	=item B<-xrm> I<string>
360		447
361	No effect on rxvt-unicode. Simply passes through an argument to be made	448	Works like the X Toolkit option of the same name, by adding the I<string>
362	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
363	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.
364		524
365	=back	525	=back
366		526
367	=head1 RESOURCES (available also as long-options)	527	=head1 RESOURCES
368		528
369	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	529	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
370	options) compiled into your version.	530	options) compiled into your version. All resources are also available as
		531	long-options.
371		532
372	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
373	Xresource data: using the X libraries (Xrm*-functions) or internal	534	distribution do also load settings from the B<~/.Xresources> file when X
374	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
375	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	536	with later settings overwriting earlier ones:
376	resources using X11 tools like B<xset>. Many distribution do also load
377	settings from the B<~/.Xresources> file when X starts.
378		537
379	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	538	1. app-defaults file in $XAPPLRESDIR
380	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	539	2. $HOME/.Xdefaults
381	set in XAPPLOADDIR/URxvt (compile-time defined: usually	540	3. RESOURCE_MANAGER property on root-window of screen 0
382	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	541	4. SCREEN_RESOURCES property on root-window of the current screen
383	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
384	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	545	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
385	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
386	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
387	easily configured, while the class name B<URxvt> allows resources	548	configured, while the class name B<URxvt> allows resources unique to
388	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	549	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
389	shared between different B<@@RXVT_NAME@@> configurations. If no	550	configurations. If no resources are specified, suitable defaults will
390	resources are specified, suitable defaults will be used. Command-line	551	be used. Command-line arguments can be used to override resource
391	arguments can be used to override resource settings. The following	552	settings. The following resources are supported (you might want to
392	resources are allowed:	553	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		554	extensions not documented here):
393		555
394	=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.
395		569
396	=item B<geometry:> I<geom>	570	=item B<geometry:> I<geom>
397		571
398	Create the window with the specified X window geometry [default 80x24];	572	Create the window with the specified X window geometry [default 80x24];
399	option B<-geometry>.	573	option B<-geometry>.
…		…
413	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
414	corresponds to low-intensity (normal) colours and 8-15 corresponds to	588	corresponds to low-intensity (normal) colours and 8-15 corresponds to
415	high-intensity (bold = bright foreground, blink = bright background)	589	high-intensity (bold = bright foreground, blink = bright background)
416	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,
417	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
418	names used are listed in the B<COLORS AND GRAPHICS> section.	592	names used are listed in the B<COLOURS AND GRAPHICS> section.
419		593
420	Colours higher than 15 cannot be set using resources (yet), but can be	594	Colours higher than 15 cannot be set using resources (yet), but can be
421	changed using an escape command (see @@RXVT_NAME@@(7)).	595	changed using an escape command (see @@RXVT_NAME@@(7)).
422		596
423	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	597	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
427		601
428	=item B<colorIT:> I<colour>	602	=item B<colorIT:> I<colour>
429		603
430	Use the specified colour to display bold or italic characters when the	604	Use the specified colour to display bold or italic characters when the
431	foreground colour is the default. If font styles are not available	605	foreground colour is the default. If font styles are not available
432	(Compile styles) and this option is unset, reverse video is used instead.	606	(Compile I<styles>) and this option is unset, reverse video is used instead.
433		607
434	=item B<colorUL:> I<colour>	608	=item B<colorUL:> I<colour>
435		609
436	Use the specified colour to display underlined characters when the	610	Use the specified colour to display underlined characters when the
437	foreground colour is the default.	611	foreground colour is the default.
438		612
439	=item B<colorRV:> I<colour>
440
441	Use the specified colour as the background for reverse video
442	characters.
443
444	=item B<underlineColor:> I<colour>	613	=item B<underlineColor:> I<colour>
445		614
446	If set, use the specified colour as the colour for the underline	615	If set, use the specified colour as the colour for the underline
447	itself. If unset, use the foreground colour.	616	itself. If unset, use the foreground colour.
		617
		618	=item B<highlightColor:> I<colour>
		619
		620	If set, use the specified colour as the background for highlighted
		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.
448		627
449	=item B<cursorColor:> I<colour>	628	=item B<cursorColor:> I<colour>
450		629
451	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
452	foreground colour; option B<-cr>.	631	foreground colour; option B<-cr>.
…		…
459		638
460	=item B<reverseVideo:> I<boolean>	639	=item B<reverseVideo:> I<boolean>
461		640
462	B<True>: simulate reverse video by foreground and background colours;	641	B<True>: simulate reverse video by foreground and background colours;
463	option B<-rv>. B<False>: regular screen colours [default]; option	642	option B<-rv>. B<False>: regular screen colours [default]; option
464	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	643	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
465		644
466	=item B<jumpScroll:> I<boolean>	645	=item B<jumpScroll:> I<boolean>
467		646
468	B<True>: specify that jump scrolling should be used. When scrolling	647	B<True>: specify that jump scrolling should be used. When receiving lots
469	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
470	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>.
471		654
472	=item B<inheritPixmap:> I<boolean>	655	=item B<skipScroll:> I<boolean>
473		656
474	B<True>: make the background inherit the parent windows' pixmap, giving	657	B<True>: (the default) specify that skip scrolling should be used. When
475	artificial transparency. B<False>: do not inherit the parent windows'	658	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
476	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>.
477		666
478	=item B<fading:> I<number>	667	=item B<fading:> I<number>
479		668
480	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>.
481		670
482	=item B<tintColor:> I<colour>	671	=item B<fadeColor:> I<colour>
483		672
484	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>.
485		675
486	=item B<shading:> I<number>	676	=item B<iconFile:> I<file>
487		677
488	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	678	Set the application icon pixmap; option B<-icon>.
489	image in addition to tinting it.
490		679
491	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
492		681
493	Use the specified colour for the scrollbar [default #B2B2B2].	682	Use the specified colour for the scrollbar [default #B2B2B2].
494		683
495	=item B<troughColor:> I<colour>	684	=item B<troughColor:> I<colour>
496		685
497	Use the specified colour for the scrollbar's trough area [default	686	Use the specified colour for the scrollbar's trough area [default
498	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	687	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
499		688
500	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
501		690
502	The colour of the border around the text area and between the scrollbar	691	The colour of the border around the text area and between the scrollbar
503	and the text.	692	and the text.
504		693
505	=item B<backgroundPixmap:> I<file[;geom]>
506
507	Use the specified XPM file (note the `.xpm' extension is optional) for
508	the background and also optionally specify its scaling with a geometry
509	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
510	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
511	centre (percent). A scale of 0 displays the image with tiling. A scale
512	of 1 displays the image without any scaling. A scale of 2 to 9
513	specifies an integer number of images in that direction. No image will
514	be magnified beyond 10 times its original size. The maximum permitted
515	scale is 1000. [default 0x0+50+50]
516
517	=item B<menu:> I<file[;tag]>
518
519	Read in the specified menu file (note the `.menu' extension is
520	optional) and also optionally specify a starting tag to find. See the
521	reference documentation for details on the syntax for the menuBar.
522
523	=item B<path:> I<path>
524
525	Specify the colon-delimited search path for finding files (XPM and
526	menus), in addition to the paths specified by the B<RXVTPATH> and
527	B<PATH> environment variables.
528
529	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
530		695
531	Select the fonts to be used. This is a comma separated list of font	696	Select the fonts to be used. This is a comma separated list of font names
532	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
533	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
534	be smaller, but not larger. A reasonable default font list is always	699	smaller, but not (in general) larger. A (hopefully) reasonable default
535	appended to it. option B<-fn>.	700	font list is always appended to it; option B<-fn>.
536		701
537	Each font can either be a standard X11 core font (XLFD) name, with	702	Each font can either be a standard X11 core font (XLFD) name, with
538	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.	703	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
539		704
540	In addition, each font can be prefixed with additional hints and	705	In addition, each font can be prefixed with additional hints and
541	specifications enclosed in square brackets (C<[]>). The only available	706	specifications enclosed in square brackets (C<[]>). The only available
542	hint currently is C<codeset=codeset-name>, and this is only used for Xft	707	hint currently is C<codeset=codeset-name>, and this is only used for Xft
543	fonts.	708	fonts.
544		709
545	For example, this font resource	710	For example, this font resource
546		711
547	URxvt*font: 9x15bold,\	712	URxvt.font: 9x15bold,\
548	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	713	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
549	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	714	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
550	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	715	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
551	xft:Code2000:antialias=false	716	xft:Code2000:antialias=false
552		717
…		…
555	it is named first) and thus defines the character cell grid to be 9 pixels	720	it is named first) and thus defines the character cell grid to be 9 pixels
556	wide and 15 pixels high.	721	wide and 15 pixels high.
557		722
558	The second font is just used to add additional unicode characters not in	723	The second font is just used to add additional unicode characters not in
559	the base font, likewise the third, which is unfortunately non-bold, but	724	the base font, likewise the third, which is unfortunately non-bold, but
560	the bold version of the font does contain less characters, so this is a	725	the bold version of the font does contain fewer characters, so this is a
561	useful supplement.	726	useful supplement.
562		727
563	The third font is an Xft font with aliasing turned off, and the characters	728	The third font is an Xft font with aliasing turned off, and the characters
564	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	729	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
565	contains other characters, but we are not interested in them.	730	contains other characters, but we are not interested in them.
…		…
586	not possible, replacement fonts of the desired shape will be tried.	751	not possible, replacement fonts of the desired shape will be tried.
587		752
588	If set, but empty, then this specific style is disabled and the normal	753	If set, but empty, then this specific style is disabled and the normal
589	text font will being used for the given style.	754	text font will being used for the given style.
590		755
591	=item B<selectstyle:> I<mode>	756	=item B<intensityStyles:> I<boolean>
592		757
593	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	758	When font styles are not enabled, or this option is enabled (B<True>,
594	xterm style with 2.20 old word selection, or anything else which gives	759	option B<-is>, the default), bold/blink font styles imply high
595	xterm style selection.	760	intensity foreground/background colours. Disabling this option (B<False>,
596		761	option B<+is>) disables this behaviour, the high intensity colours are not
597	=item B<scrollstyle:> I<mode>	762	reachable.
598
599	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
600	the author's favourite..
601		763
602	=item B<title:> I<string>	764	=item B<title:> I<string>
603		765
604	Set window title string, the default title is the command-line	766	Set window title string, the default title is the command-line
605	specified after the B<-e> option, if any, otherwise the application	767	specified after the B<-e> option, if any, otherwise the application
…		…
614	=item B<mapAlert:> I<boolean>	776	=item B<mapAlert:> I<boolean>
615		777
616	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
617	de-iconify (map) on receipt of a bell character [default].	779	de-iconify (map) on receipt of a bell character [default].
618		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
619	=item B<visualBell:> I<boolean>	788	=item B<visualBell:> I<boolean>
620		789
621	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>.
622	B<False>: no visual bell [default]; option B<+vb>.	791	B<False>: no visual bell [default]; option B<+vb>.
623		792
…		…
625		794
626	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
627	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
628	[default]; option B<+ls>.	797	[default]; option B<+ls>.
629		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
630	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
631		805
632	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>;
633	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>
634	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
637		811
638	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
639	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
640	B<Shift-Print> to include the scrollback as well.	814	B<Shift-Print> to include the scrollback as well.
641		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
642	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
643		835
644	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
645	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
646		838
…		…
665	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
666	B<+si>.	858	B<+si>.
667		859
668	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
669		861
670	B<True>: scroll with scrollback buffer when tty receives new lines (and	862	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
671	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
672	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>.
673		866
674	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
675		868
676	B<True>: scroll to bottom when a non-special key is pressed. Special keys	869	B<True>: scroll to bottom when a non-special key is pressed. Special keys
677	are those which are intercepted by rxvt-unicode for special handling and	870	are those which are intercepted by rxvt-unicode for special handling and
678	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	871	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
679	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
680		873
681	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
682		875
683	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>.
684	resource is limited on most machines to 65535; option B<-sl>.
685		877
686	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
687		879
688	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;
689	option B<-b>.	881	option B<-b>.
…		…
696	=item B<borderLess:> I<boolean>	888	=item B<borderLess:> I<boolean>
697		889
698	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
699	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	891	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
700		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>.
		899
701	=item B<termName:> I<termname>	900	=item B<termName:> I<termname>
702		901
703	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
704	variable; option B<-tn>.	903	variable; option B<-tn>.
705		904
706	=item B<linespace:> I<number>	905	=item B<lineSpace:> I<number>
707		906
708	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
709	the display [default 0]; option B<-lsp>.	908	the display [default 0]; option B<-lsp>.
710		909
711	=item B<meta8:> I<boolean>	910	=item B<meta8:> I<boolean>
…		…
725		924
726	=item B<cursorBlink:> I<boolean>	925	=item B<cursorBlink:> I<boolean>
727		926
728	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];
729	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>.
730		934
731	=item B<pointerBlank:> I<boolean>	935	=item B<pointerBlank:> I<boolean>
732		936
733	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
734	of seconds of inactivity. B<False>: the pointer is always visible	938	of seconds of inactivity. B<False>: the pointer is always visible
…		…
740		944
741	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
742		946
743	Mouse pointer background colour.	947	Mouse pointer background colour.
744		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
745	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
746		956
747	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.
748		959
749	=item B<backspacekey:> I<string>	960	=item B<backspacekey:> I<string>
750		961
751	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>
752	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>
753	(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
754	escape sequence.	965	escape sequence.
755		966
756	=item B<deletekey:> I<string>	967	=item B<deletekey:> I<string>
757		968
…		…
759	pressed. If unset it will send the sequence traditionally associated	970	pressed. If unset it will send the sequence traditionally associated
760	with the B<Execute> key.	971	with the B<Execute> key.
761		972
762	=item B<cutchars:> I<string>	973	=item B<cutchars:> I<string>
763		974
764	The characters used as delimiters for double-click word selection. The	975	The characters used as delimiters for double-click word selection
765	built-in default:	976	(whitespace delimiting is added automatically if resource is given).
766		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
767	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
768		987
769	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
770		989
771	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
772		991
773	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
774		993
775	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
776		995
777	=item B<imLocale:> I<name>	996	=item B<imLocale:> I<name>
778		997
779	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.
780	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
781	extension to be able to input japanese characters while staying in	1000	input extension to be able to input japanese characters while staying in
782	another locale. option B<-imlocale>.	1001	another locale; option B<-imlocale>.
		1002
		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>.
783		1017
784	=item B<insecure:> I<boolean>	1018	=item B<insecure:> I<boolean>
785		1019
786	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1020	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
787	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
788	abused if somebody gets 8-bit-clean access to your display, whether	1022	abused if somebody gets 8-bit-clean access to your display, whether
789	throuh a mail client displaying mail bodies unfiltered or though	1023	through a mail client displaying mail bodies unfiltered or through
790	write(1). Therefore, these sequences are disabled by default. (Note	1024	write(1) or any other means. Therefore, these sequences are disabled by
791	that other terminals, including xterm, have these sequences	1025	default. (Note that many other terminals, including xterm, have these
792	enabled by default). You can enable them by setting this boolean	1026	sequences enabled by default, which doesn't make it safer, though).
793	resource or specifying B<-insecure> as an option. At the moment, this	1027
794	enabled display-answer, locale, findfont, icon label and window title	1028	You can enable them by setting this boolean resource or specifying
795	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.
796		1031
797	=item B<modifier:> I<modifier>	1032	=item B<modifier:> I<modifier>
798		1033
799	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>,
800	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
…		…
804		1039
805	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1040	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
806	character is passed through. It may contain escape values as described	1041	character is passed through. It may contain escape values as described
807	in the entry on B<keysym> following.	1042	in the entry on B<keysym> following.
808		1043
809	=item B<secondaryScreen:> I<bool>	1044	=item B<secondaryScreen:> I<boolean>
810		1045
811	Turn on/off secondary screen (default enabled).	1046	Turn on/off secondary screen (default enabled).
812		1047
813	=item B<secondaryScroll:> I<bool>	1048	=item B<secondaryScroll:> I<boolean>
814		1049
815	Turn on/off secondary screen scroll (default enabled). If the this	1050	Turn on/off secondary screen scroll (default enabled). If this
816	option is enabled, scrolls on the secondary screen will change the	1051	option is enabled, scrolls on the secondary screen will change the
817	scrollback buffer and switching to/from the secondary screen will	1052	scrollback buffer and, when secondaryScreen is off, switching
818	instead scroll the screen up.	1053	to/from the secondary screen will instead scroll the screen up.
819		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
820	=item B<keysym.>I<sym>: I<string>	1069	=item B<keysym.>I<sym>: I<action>
821		1070
822	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
823	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	1072	resource name B<keysym.> cannot be omitted.
824	newline, \r: return, \t:	1073
825	tab, \000: octal number) or control characters (^?: delete, ^@: null,	1074	Using this resource, you can map key combinations such as
826	^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
827	with whitespace. The intervening resource name B<keysym.> cannot be	1076	string than would normally result from that combination, making the
828	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
829	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> I<or> 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).
830		1340
831	=back	1341	=back
832		1342
833	=head1 THE SCROLLBAR	1343	=head1 THE SCROLLBAR
834		1344
…		…
848	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
849	(Alt) key while performing the desired mouse action.	1359	(Alt) key while performing the desired mouse action.
850		1360
851	If mouse reporting mode is active, the normal scrollbar actions are	1361	If mouse reporting mode is active, the normal scrollbar actions are
852	disabled -- on the assumption that we are using a fullscreen	1362	disabled -- on the assumption that we are using a fullscreen
853	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1363	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
854	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1364	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
855	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),
856	respectively.	1366	respectively.
857		1367
858	=head1 TEXT SELECTION AND INSERTION	1368	=head1 THE SELECTION: SELECTING AND PASTING TEXT
859		1369
860	The behaviour of text selection and insertion mechanism is similar to	1370	The behaviour of text selection and insertion/pasting mechanism is similar
861	I<xterm>(1).	1371	to I<xterm>(1).
862		1372
863	=over 4	1373	=over 4
864		1374
865	=item B<Selection>:	1375	=item B<Selecting>:
866		1376
867	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
868	region and release; Right click to extend the marked region; Left	1378	and release; Right click to extend the marked region; Left double-click
869	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
870	line.	1380	(which can span multiple screen lines), unless modified by resource
		1381	B<tripleclickwords>.
871		1382
872	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1383	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
873	(Compile: frills) will create a rectangular selection instead of a normal	1384	(Compile: I<frills>) will create a rectangular selection instead of a
874	one.	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.
875		1388
876	=item B<Insertion>:	1389	=item B<Pasting>:
877		1390
878	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@@>
879	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
880	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.
881		1403
882	=back	1404	=back
883		1405
884	=head1 CHANGING FONTS	1406	=head1 CHANGING FONTS
885		1407
886	Changing fonts (or font sizes, respectively) via the keypad is not yet	1408	Changing fonts (or font sizes, respectively) via the keypad is not yet
887	supported in rxvt-unicode. Bug me if you need this.	1409	supported in rxvt-unicode. Bug me if you need this.
888		1410
889	You can, however, switch fonts at runtime using escape sequences (and	1411	You can, however, switch fonts at runtime using escape sequences, e.g.:
890	therefore using the menubar), e.g.:
891		1412
892	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	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
893		1419
894	rxvt-unicode will automatically re-apply these fonts to the output so far.	1420	rxvt-unicode will automatically re-apply these fonts to the output so far.
895		1421
896	=head1 ISO 14755 SUPPORT	1422	=head1 ISO 14755 SUPPORT
897		1423
898	ISO 14755 is a standard for entering and viewing unicode characters	1424	ISO 14755 is a standard for entering and viewing unicode characters
899	and character codes using the keyboard. It consists of 4 parts. The	1425	and character codes using the keyboard. It consists of 4 parts. The
900	first part is available rxvt-unicode has been compiled with	1426	first part is available if rxvt-unicode has been compiled with
901	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1427	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
902	with C<--enable-iso14755>.	1428	with C<--enable-iso14755>.
903		1429
904	=over 4	1430	=over 4
905		1431
906	=item 5.1: Basic method	1432	=item * 5.1: Basic method
907		1433
908	This allows you to enter unicode characters using their hexcode.	1434	This allows you to enter unicode characters using their hexcode.
909		1435
910	Start by pressing and holding both C<Control> and C<Shift>, then enter	1436	Start by pressing and holding both C<Control> and C<Shift>, then enter
911	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1437	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
918	address, which you cannot type. Fortunately, the card has the e-mail	1444	address, which you cannot type. Fortunately, the card has the e-mail
919	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1445	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
920	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1446	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
921	followed by releasing the modifier keys.	1447	followed by releasing the modifier keys.
922		1448
923	=item 5.2: Keyboard symbols entry method	1449	=item * 5.2: Keyboard symbols entry method
924		1450
925	This mode lets you input characters representing the keycap symbols of	1451	This mode lets you input characters representing the keycap symbols of
926	your keyboard, if representable in the current locale encoding.	1452	your keyboard, if representable in the current locale encoding.
927		1453
928	Start by pressing C<Control> and C<Shift> together, then releasing	1454	Start by pressing C<Control> and C<Shift> together, then releasing
929	them. The next special key (cursor keys, home etc.) you enter will not	1455	them. The next special key (cursor keys, home etc.) you enter will not
930	invoke it's usual function but instead will insert the corresponding	1456	invoke its usual function but instead will insert the corresponding
931	keycap symbol. The symbol will only be entered when the key has been	1457	keycap symbol. The symbol will only be entered when the key has been
932	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1458	released, otherwise pressing e.g. C<Shift> would enter the symbol for
933	C<ISO Level 2 Switch>, although your intention might have been to enter a	1459	C<ISO Level 2 Switch>, although your intention might have been to enter a
934	reverse tab (Shift-Tab).	1460	reverse tab (Shift-Tab).
935		1461
936	=item 5.3: Screen-selection entry method	1462	=item * 5.3: Screen-selection entry method
937		1463
938	While this is implemented already (it's basically the selection	1464	While this is implemented already (it's basically the selection
939	mechanism), it could be extended by displaying a unicode character map.	1465	mechanism), it could be extended by displaying a unicode character map.
940		1466
941	=item 5.4: Feedback method for identifying displayed characters for later input	1467	=item * 5.4: Feedback method for identifying displayed characters for later input
942		1468
943	This method lets you display the unicode character code associated with	1469	This method lets you display the unicode character code associated with
944	characters already displayed.	1470	characters already displayed.
945		1471
946	You enter this mode by holding down C<Control> and C<Shift> together, then	1472	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
958	With respect to conformance, rxvt-unicode is supposed to be compliant to	1484	With respect to conformance, rxvt-unicode is supposed to be compliant to
959	both scenario A and B of ISO 14755, including part 5.2.	1485	both scenario A and B of ISO 14755, including part 5.2.
960		1486
961	=head1 LOGIN STAMP	1487	=head1 LOGIN STAMP
962		1488
963	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
964	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
965	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
966	some systems.	1492	on some systems or setgid to root or to some other group on others.
967		1493
968	=head1 COLORS AND GRAPHICS	1494	=head1 COLOURS AND GRAPHICS
969		1495
970	In addition to the default foreground and background colours,	1496	In addition to the default foreground and background colours,
971	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
972	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
973	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.
974		1512
975	=begin table	1513	=begin table
976		1514
977	B<color0> (black) = Black	1515	B<color0> (black) = Black
978	B<color1> (red) = Red3	1516	B<color1> (red) = Red3
…		…
998	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>,
999	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1537	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1000	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
1001	color0-color15.	1539	color0-color15.
1002		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
1003	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1560	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1004	always swapping the foreground/background colours. This is in contrast to	1561	always swapping the foreground/background colours. This is in contrast to
1005	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
1006	been specified. For example,	1563	been specified. For example,
1007		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
1008	=over 4	1620	=over 4
1009		1621
1010	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1622	=item B<TERM>
1011		1623
1012	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
1013	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@@.
1014		1696
1015	=back	1697	=back
1016		1698
1017	=head1 ENVIRONMENT
1018
1019	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1020	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1021	window id number of the B<@@RXVT_NAME@@> window and it also uses and
1022	sets the environment variable B<DISPLAY> to specify which display
1023	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1024	B<RXVTPATH> and B<PATH> to find XPM files.
1025
1026	=head1 FILES	1699	=head1 FILES
1027		1700
1028	=over 4	1701	=over 4
1029		1702
1030	=item B</etc/utmp>
1031
1032	System file for login records.
1033
1034	=item B</usr/lib/X11/rgb.txt>	1703	=item B</usr/lib/X11/rgb.txt>
1035		1704
1036	Color names.	1705	Colour names.
1037		1706
1038	=back	1707	=back
1039		1708
1040	=head1 SEE ALSO	1709	=head1 SEE ALSO
1041		1710
		1711	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1042	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1712	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1043
1044	=head1 BUGS
1045
1046	Check the BUGS file for an up-to-date list.
1047
1048	Cursor change support is not yet implemented.
1049
1050	Click-and-drag doesn't work with X11 mouse report overriding.
1051		1713
1052	=head1 CURRENT PROJECT COORDINATOR	1714	=head1 CURRENT PROJECT COORDINATOR
1053		1715
1054	=over 4	1716	=over 4
1055		1717
1056	=item Project Coordinator	1718	=item Project Coordinator
1057		1719
1058	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1720	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1059		1721
1060	=item Web page maintainter	1722	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1061
1062	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1063
1064	L<@@RXVT_WEBPAGE@@>
1065		1723
1066	=back	1724	=back
1067		1725
1068	=head1 AUTHORS	1726	=head1 AUTHORS
1069		1727
…		…
1071		1729
1072	=item John Bovey	1730	=item John Bovey
1073		1731
1074	University of Kent, 1992, wrote the original Xvt.	1732	University of Kent, 1992, wrote the original Xvt.
1075		1733
1076	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1734	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1077		1735
1078	very heavily modified Xvt and came up with Rxvt	1736	very heavily modified Xvt and came up with Rxvt
1079		1737
1080	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1738	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1081		1739
1082	wrote the Greek Keyboard Input (no longer in code)	1740	wrote the Greek Keyboard Input (no longer in code)
1083		1741
1084	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1742	=item mj olesen <olesen@me.QueensU.CA>
1085		1743
1086	Wrote the menu system.	1744	Wrote the menu system.
1087		1745
1088	Project Coordinator (changes.txt 2.11 to 2.21)	1746	Project Coordinator (changes.txt 2.11 to 2.21)
1089		1747
1090	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1748	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1091		1749
1092	Project Coordinator (changes.txt 2.21a to 2.4.5)	1750	Project Coordinator (changes.txt 2.21a to 2.4.5)
1093		1751
1094	=item Geoff Wing L<< <gcw@pobox.com> >>	1752	=item Geoff Wing <gcw@pobox.com>
1095		1753
1096	Rewrote screen display and text selection routines. Project Coordinator	1754	Rewrote screen display and text selection routines.
		1755
1097	(changes.txt 2.4.6 - rxvt-unicode)	1756	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1098		1757
1099	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1758	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1100		1759
1101	Forked rxvt-unicode, rewrote most of the display code and internal	1760	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1102	character handling to store text in unicode, improve xterm	1761	extension, random hacks, numerous bugfixes and extensions.
1103	compatibility and apply numerous other bugfixes and extensions.
1104		1762
1105	Project Coordinator (Changes 1.0 -)	1763	Project Coordinator (Changes 1.0 -)
1106		1764
		1765	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
		1766
		1767	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1768
1107	=back	1769	=back
1108		1770

Diff Legend

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