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

Diff Legend

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